PHPCS 设置 snake_case 属性命名规范方法

本文介绍如何通过 PHP_CodeSniffer（PHPCS）配置规则，严格约束类属性（properties）必须使用 $snake_case 命名风格，避免驼峰式（camelCase）或 PascalCase，并推荐基于 WordPress Coding Standards 的成熟解决方案。

本文介绍如何通过 PHP_CodeSniffer（PHPCS）配置规则，严格约束类属性（properties）必须使用 `$snake_case` 命名风格，避免驼峰式（camelCase）或 PascalCase，并推荐基于 WordPress Coding Standards 的成熟解决方案。

在 PHP 项目中统一变量命名规范是保障代码可读性与团队协作效率的重要实践。PHPCS 本身默认规则集（如 Squiz、PSR12）主要关注变量名是否符合 camelCase，但不原生提供仅针对属性（即类成员变量）强制 snake_case 的独立规则。例如 <rule ref="Squiz.NamingConventions.ValidVariableName.NotCamelCaps"/> 会检查所有变量（含局部变量、参数、属性），且其逻辑是“拒绝非驼峰”，而非“要求蛇形”。

✅ 正确做法：引入 WordPress Coding Standards（WPCS） —— 它提供了精准作用于属性的专用规则：

<rule ref="WordPress.NamingConventions.ValidVariableName.VariableNotSnakeCase"/>

该规则仅校验类属性（public $foo_bar;、private $user_id; 等），若发现属性名未使用 snake_case（如 $firstName 或 $FirstName），将抛出错误；而局部变量（如 foreach ($items as $item_name) 中的 $item_name）和函数参数不受此规则影响，确保了作用域的精确性。

? 使用前提：

• 已安装 WPCS：composer require --dev wp-coding-standards/wpcs
• 执行 phpcbf --config-set installed_paths vendor/wp-coding-standards/wpcs
• 在 phpcs.xml 或 ruleset.xml 中引用上述规则

⚠️ 注意事项：

• 不要混用 Squiz.NamingConventions.ValidVariableName 类规则，因其粒度粗、易误报；
• WPCS 的 VariableNotSnakeCase 默认仅检查属性，但可通过 <property name="scope" value="property"/> 显式强化（非必需）；
• 若项目已使用 PSR-12，建议将 WPCS 规则置于自定义 ruleset 中并合理排序，避免冲突；
• 运行修复命令：phpcbf --standard=YourRuleset . 可自动将违规属性重命名为 snake_case（如 $userID → $user_id）。

总结：PHPCS 原生能力有限，而 WPCS 提供了语义清晰、范围精准的 WordPress.NamingConventions.ValidVariableName.VariableNotSnakeCase 规则，是强制类属性使用 $snake_case 的最佳实践方案。