wptrt/wpthemereview

PHP_CodeSniffer rules (sniffs) to verify theme compliance with the rules for theme hosting on wordpress.org

0.2.1 2019-11-17 20:05 UTC

Requires

• php: >=5.4
• phpcompatibility/phpcompatibility-wp: ^2.0
• squizlabs/php_codesniffer: ^3.3.1
• wp-coding-standards/wpcs: ^2.2.0

Requires (Dev)

• dealerdirect/phpcodesniffer-composer-installer: ^0.5.0
• phpcompatibility/php-compatibility: ^9.0
• phpunit/phpunit: ^4.0 || ^5.0 || ^6.0 || ^7.0
• roave/security-advisories: dev-master

Suggests

• dealerdirect/phpcodesniffer-composer-installer: ^0.5.0 || This Composer plugin will sort out the PHPCS 'installed_paths' automatically.

MIT

• Theme Review Team
• Ulrich Pogson
• Juliette Reinders Folmer
• Denis Žoljom
• Contributors

• themes
• wordpress
• standards
• phpcs

README

WPThemeReview Standard for PHP_CodeSniffer

• Introduction
• Requirements
• Installation
  • Installing WPThemeReview globally
  • Installing WPThemeReview as a project dependency
  • Checking your installation was successful
• Using the WPThemeReview standard
• Contributing
• License

Introduction

WordPress Themes for which a hosting application has been made for the theme to be hosted in the theme repository on wordpress.org have to comply with a set of requirements before such an application can be approved. Additionally, there are also recommendations for best practices for themes.

This project attempts to automate the code analysis part of the Theme Review Process as much as possible using static code analysis.

PHP_CodeSniffer is the base tool upon which this project is build and is a PHP command-line tool.

This project is a work in progress and passing the checks is no guarantee that your theme will be approved.

Requirements

The WPThemeReview Standard requires:

• PHP 5.4 or higher.
• PHP_CodeSniffer version 3.3.1 or higher.
• WordPress Coding Standards version 2.2.0 or higher.
• PHPCompatibilityWP version 2.0.0 or higher.

Installation

The only supported installation method is via Composer.

1. Make sure you have PHP installed on your system.
2. If not installed yet, install Composer.

Installing WPThemeReview globally

If you would like to have the WPThemeReview standard available to all projects on your system, you can install it in a central location.

From the command-line, run the following command:

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

Installing WPThemeReview as a project dependency

If you use Composer to manage dependencies from your project anyway or are considering using it, you can also choose to install the WPThemeReview standard for an individual project.

From the command-line, run the following command from the root directory of your project:

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

Note:

• The --dev means that WPThemeReview will be installed as a development requirement, not as a requirement for using the Theme.
• The second package - dealerdirect/phpcodesniffer-composer-installer -, is a Composer plugin which will automatically sort out that PHP_CodeSniffer recognizes the WPThemeReview standard and the various WordPress standards.

Checking your installation was successful

# For a global install:
$ phpcs -i

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

If everything went well, the output should look something like this:

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

Using the WPThemeReview standard

You can now test your theme code against the WPThemeReview standard by running the following command from the root directory of your theme:

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

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

If any issues are found, PHP_CodeSniffer will display a report with all the errors (must fix) and warnings (recommended to fix) for each file.

More information about running PHP_CodeSniffer can be found in the PHP_CodeSniffer Wiki.

Contributing

See CONTRIBUTING, including information about unit testing the standard.

License

See LICENSE (MIT).