跳到内容

WPTT/WP主题审查

最新版本 上次提交不稳定 CS构建状态 测试生成状态

最低PHP版本 许可证:麻省理工学院 贡献者数量

PHP_CodeSniffer的WPThemeReview标准

介绍

WordPress主题,已为主题创建托管应用程序,主题将在主题库中托管wordpress.org网站必须遵守一套要求在此类申请获得批准之前。此外,还有建议主题的最佳实践。

此项目尝试自动执行主题审查流程尽可能使用静态代码分析。

PHP_代码嗅探器是构建此项目的基础工具,也是PHP命令行工具。

这个项目正在进行中,通过检查并不能保证你的主题会被批准。

要求

WPThemeReview标准要求:

安装

唯一支持的安装方法是通过作曲家.

  1. 确保系统上安装了PHP。
  2. 如果尚未安装,请安装作曲家.

全局安装WPThemeReview

如果希望WPThemeReview标准可用于系统上的所有项目,可以将其安装在中心位置。

从命令行运行以下命令:

$php composer.phar global需要wptrt/wpthemereview经销商direct/phpcodesniffer-composer-installer

作为项目依赖项安装WPThemeReview

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

从命令行中,从项目的根目录运行以下命令:

$php composer.phar需要--dev-wptrt/wpthemereview:*dealerdirect/phpcodesiffer-composer-installer:^0.7

注:

  • 这个--开发意味着WPThemeReview将作为开发需求安装,而不是作为使用主题的需求。
  • 第二个包-dealerdirect/phpcodesniffer-composer-installer-是一个Composer插件,它将自动排序PHP_CodeSniffer识别WPThemeReview标准和各种WordPress标准。

检查您的安装是否成功

#对于全局安装:$phpcs-i#对于项目安装:$vendor/bin/phpcs-i

如果一切顺利,输出应该如下所示:

已安装的编码标准包括MySource、PEAR、PSR1、PSR12、PSR2、Squiz、Zend、PHP兼容性、,PHP兼容性ParagonieRandomCompat、PHP兼容性paragonieSodiumCompat、pH兼容性WP、,WordPress、WordPress-Core、WordPRES-Docs、WordPress-Extra和WPThemeReview

使用WPThemeReview标准

现在可以通过从主题的根目录运行以下命令,根据WPThemeReview标准测试主题代码:

#对于全局安装:$phpcs-磅.--标准=WPThemeReview#对于项目安装:$vendor/bin/phpcs-p.--标准=WPThemeReview

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

有关运行PHP_CodeSniffer的更多信息,请参阅PHP_CodeSniffer Wiki.

贡献

请参见贡献,包括有关单元测试标准。

许可证

请参见许可证(麻省理工学院)。

关于

PHP_CodeSniffer规则(嗅探)以强制WordPress主题审查编码约定

话题

资源

许可证

星星

观察者

叉子

包装

未发布包

语言文字