README

弃用通知

该项目不再积极维护。我们建议使用 WordPress 编码规范并使用它们的推荐配置为您的项目。

关于

WordPress 的 WP Engine 编码规范

如果 WordPress 编码规范为开发者提供了在贡献或扩展 WordPress 时的基线，那么请将 WP Engine 编码规范视为一个额外的最佳实践层，它

帮助开发者在其主题和插件中实现更高的一致性
帮助开发者满足 WP Engine 解决方案合作伙伴的要求
确保 WP Engine 解决方案中心中列出的所有软件都是最高质量的
在现代托管环境中（PHP 7+）使用这些主题和插件时，为用户提供最大性能和安全优势

以下信息将指导您安装和使用 WP Engine 编码规范以检查您的代码。

要求

WP Engine 编码规范（WPECS）使用 Composer 安装以下主要依赖项

如果您在 Mac 上使用 Homebrew，可以使用以下命令安装 Composer： brew install composer。否则，请遵循 Composer 的官方安装说明。

安装

全局安装

克隆存储库并安装依赖项

git clone git@github.com:wpengine/wpengine-coding-standards.git
cd wpengine-coding-standards
composer install

将您的编码规范链接到您的 phpcs 安装

phpcs --config-set installed_paths /path/to/wp-engine-coding-standards

作为依赖项安装

您还可以将编码规范作为依赖项安装到您的本地项目中。以下是方法：

将以下存储库添加到您的 composer.json 中

"repositories": [
    {
      "type": "git",
      "url": "https://github.com/wpengine/wpengine-coding-standards.git"
    }
  ]

手动将以下内容添加到 composer.json 中的 require-dev

"wpengine/wpengine-coding-standards": "dev-master"

运行 composer install 或 composer update 以确保您的项目已配置。
现在，您可以在任何使用本地 phpcs 的 IDE 中使用 WP-Engine 或 WP-Engine-Strict。如果您在项目中已经有 phpcs.xml，只需将其添加到其中

 <rule ref="WP-Engine-Strict"/>

替代安装（wpecs 命令）

克隆或下载此存储库。从终端导航到下载位置，并使用以下命令全局安装 WPECS

make install

然后您将能够从任何目录运行 WPECS。

运行 make install 将安装 WPECS 依赖项并将编码规范与 PHPCS 注册。

注意，如果 make 失败，您可能需要手动将二进制文件移动到您的路径，或正确设置路径。

用法

命令行

在给定的文件或目录上运行 phpcs 命令行工具，例如

phpcs --standard=WP-Engine wp-load.php

WP-Engine 编码规范

安全 WordPress 开发的必要标准。

wpecs .

WP-Engine-Strict 编码规范

WP Engine 编写插件的推荐标准。

wpecs --standard="WP-Engine-Strict" .

在 IDE 中使用 PHPCS 和 WP Engine 编码规范

以下内容基于父 WordPress 编码规范，只需将所需的规则集替换为 WP-Engine 或 WP-Engine-Strict 即可。

PhpStorm : 请参阅PhpStorm文档中的 "PHP Code Sniffer with WordPress Coding Standards Integration"。
Sublime Text : 请参阅维基中的 "Setting up WPCS to work in Sublime Text"。
Atom : 请参阅维基中的 "Setting up WPCS to work in Atom"。
Visual Studio : 请参阅Tom McFarlin的教程 "Setting up PHP CodeSniffer in Visual Studio Code"。
Eclipse with XAMPP : 请参阅维基中的 "Setting up WPCS when using Eclipse with XAMPP"。

替代用法（wpecs）

用法：wpecs [--strict] [phpcs-options] 对指定路径执行WP Engine编码标准检查。尝试修复针对WP Engine严格编码标准的sniffs。

结果

要了解错误或警告以及特定问题的故障排除建议，请参阅完整的WP Engine编码标准文档。

贡献者许可协议

所有外部贡献者必须签署贡献者许可协议（CLA），才能将贡献纳入任何WP Engine代码库。

提交您的姓名和电子邮件
📝 签署您收到的CLA
📥 收到已签署的CLA副本

❤️ 感谢您帮助我们履行法律义务，以便继续通过无头WordPress赋能构建者。

wpengine / wpengine-coding-standards

维护者

详细信息