PHP_CodeSniffer rules (sniffs) to enforce CIG coding conventions
Using CIG PHP coding standards ruleset for PHPCodeSniffer, you can analyse the codebase of your project for PHP compatibility with other _itcig projects.
A ruleset for PHPCodeSniffer to check for PHP compatibility and standards across all _itcig PHP projects.
This WordPress specific ruleset prevents false positives from the PHPCompatibility standard by excluding back-fills and poly-fills which are provided by WordPress.
These will all be installed automatically by this ruleset so you do not need to include them explicitly.
- PHP_CodeSniffer. Use the latest stable release of PHP_CodeSniffer for the best results. The minimum recommended version of PHP_CodeSniffer is version 3.0.2.
- PHPCompatibility 9.0.0+.
The only supported installation method is via Composer.
If you already have a Composer PHP_CodeSniffer plugin installed, run:
composer require --dev itcig/php-coding-standards:"*" composer install
If all went well, you will now see that the
PHPCompatibilityWP and some more
PHPCompatibility standards are installed for PHP_CodeSniffer.
Now you can use the following command to inspect your code:
./vendor/bin/phpcs -p . --standard=CIG
By default, you will only receive notifications about formatting and deprecated and/or removed PHP features.
To get the most out of the CIG coding and PHPCompatibility standards, you should
testVersion to check against. That will enable the checks for both
deprecated/removed PHP features as well as the detection of code using new PHP
If you want to enforce the minimum PHP requirement, either add
--runtime-set testVersion 7.2- to your command-line command or add
<config name="testVersion" value="7.2-"/> to your
# For a project which should be compatible with PHP 7.2 and higher: ./vendor/bin/phpcs -p . --standard=CIG --runtime-set testVersion 7.2-
For more detailed information about setting the
testVersion, see the README of
./vendor/bin/phpcs -p . --standard=CIG --extensions=php --runtime-set testVersion 7.2-