The PHP Coding Standards Fixer (PHP CS Fixer) tool fixes your code to follow standards; whether you want to follow PHP coding standards as defined in the PSR-1, PSR-2, etc., or other community driven ones like the Symfony one. You can also define your (team's) style through configuration.
It can modernize your code (like converting the
pow function to the
** operator on PHP 5.6)
and (micro) optimize it.
If you are already using a linter to identify coding standards problems in your code, you know that fixing them by hand is tedious, especially on large projects. This tool does not only detect them, but also fixes them for you.
- PHP 7.4
- PHP 8.0 (except PHP 8.0.0 due to bug in PHP tokenizer)
- PHP 8.1
- PHP 8.2
Each new PHP version requires a huge effort to support the new syntax. That's why the latest PHP version might not be supported yet. If you need it, please, consider supporting the project in any convenient way, for example with code contribution or reviewing existing PRs. To run PHP CS Fixer on yet unsupported versions "at your own risk" - leverage the PHP_CS_FIXER_IGNORE_ENV.
The recommended way to install PHP CS Fixer is to use Composer
in a dedicated
composer.json file in your project, for example in the
mkdir -p tools/php-cs-fixer composer require --working-dir=tools/php-cs-fixer friendsofphp/php-cs-fixer
Or using the main
composer require --dev friendsofphp/php-cs-fixer
For more details and other installation methods, see installation instructions.
Assuming you installed PHP CS Fixer as instructed above, you can run the
following command to fix the files PHP files in the
tools/php-cs-fixer/vendor/bin/php-cs-fixer fix src
If you need to apply code styles that are not supported by the tool, you can create custom rules.
Dedicated plugins exist for:
The PHP CS Fixer is maintained on GitHub at https://github.com/PHP-CS-Fixer/PHP-CS-Fixer. Bug reports and ideas about new features are welcome there.
You can reach us at https://gitter.im/PHP-CS-Fixer/Lobby about the project, configuration, possible improvements, ideas and questions, please visit us!
The tool comes with quite a few built-in fixers, but everyone is more than welcome to contribute more of them.