README

WPThemeReview 标准用于 PHP_CodeSniffer

• 简介
• 需求
• 安装
  • 全局安装 WPThemeReview
  • 将 WPThemeReview 安装为项目依赖
  • 检查您的安装是否成功
• 使用 WPThemeReview 标准
• 贡献
• 许可证

简介

WordPress 主题，如果已在wordpress.org的主题仓库中创建了托管应用程序，则该主题必须符合一组要求，才能批准此类申请。此外，还有一些最佳实践建议。

该项目尝试尽可能通过静态代码分析自动化主题审核过程的代码分析部分。

PHP_CodeSniffer是该项目的基础工具，它是一个PHP命令行工具。

该项目是一个正在进行中的项目，通过检查并不能保证您的主题会被批准。

需求

WPThemeReview 标准需要

• PHP 5.4 或更高版本。
• PHP_CodeSniffer版本 3.3.1 或更高版本。
• WordPress 编码标准版本 2.2.0 或更高版本。
• PHPCompatibilityWP版本 2.0.0 或更高版本。

安装

唯一支持的安装方法是使用Composer。

1. 确保您的系统上已安装PHP。
2. 如果尚未安装，请安装Composer。

全局安装 WPThemeReview

如果您希望将WPThemeReview标准用于系统上的所有项目，您可以在中央位置安装它。

在命令行中，运行以下命令

$ php composer.phar global require wptrt/wpthemereview dealerdirect/phpcodesniffer-composer-installer

将 WPThemeReview 安装为项目依赖

如果您使用Composer管理项目的依赖项，或者正在考虑使用它，您还可以选择为单个项目安装WPThemeReview标准。

在命令行中，从您的项目的根目录运行以下命令

$ php composer.phar require --dev wptrt/wpthemereview:* dealerdirect/phpcodesniffer-composer-installer:^0.7

注意

• --dev 表示WPThemeReview将被安装为开发需求，而不是主题使用需求。
• 第二个包 - dealerdirect/phpcodesniffer-composer-installer - 是一个Composer插件，它将自动处理PHP_CodeSniffer识别WPThemeReview标准和各种WordPress标准。

检查您的安装是否成功

# For a global install:
$ phpcs -i

# For a project install:
$ vendor/bin/phpcs -i

如果一切顺利，输出应类似于以下内容

The installed coding standards are MySource, PEAR, PSR1, PSR12, PSR2, Squiz, Zend, PHPCompatibility,
PHPCompatibilityParagonieRandomCompat, PHPCompatibilityParagonieSodiumCompat, PHPCompatibilityWP,
WordPress, WordPress-Core, WordPress-Docs, WordPress-Extra and WPThemeReview

使用 WPThemeReview 标准

现在，您可以通过从主题的根目录运行以下命令来测试您的主题代码是否与WPThemeReview标准兼容

# For a global install:
$ phpcs -p . --standard=WPThemeReview

# For a project install:
$ vendor/bin/phpcs -p . --standard=WPThemeReview

如果发现任何问题，PHP_CodeSniffer将显示一个报告，其中包含每个文件的错误（必须修复）和警告（建议修复）。

有关运行PHP_CodeSniffer的更多信息，请参阅PHP_CodeSniffer Wiki。

贡献

请参阅CONTRIBUTING，其中包括有关单元测试标准的信息。

许可证

请参阅LICENSE（MIT许可证）。