Использование PHP CodeSniffer при разработке для WordPress

PHP CodeSniffer сканирует исходный код и выявляет несоответствие заранее определенному набору стандартов. Следование этим стандартам является правилом хорошего тона если вы разрабатываете плагин или тему. Они упрощают чтение и модификацию кода. При чтении кода, написанного разными разработчиками, но отформатированного в соответствии со стандартами, складывавается ощущение что весь этот код написан одним разработчиком.

PHP CodeSniffer состоит из двух скриптов:

• phpcs — сканирует исходный код
• phpcbf — исправляет ошибки, если это возможно

Установка

PHP CodeSniffer можно установить различными способами. Для установки через Composer выполните команду

composer create-project wp-coding-standards/wpcs --no-dev

Для запуска:

./wpcs/vendor/bin/phpcs ./wpcs/vendor/bin/phpcbf

Для удобства можно добавить wpcs/vendor/bin в переменную окружения PATH, и установить набор правил WordPress по умолчанию, чтобы не указывать его каждый раз при запуске

phpcs --config-set default_standard WordPress

Наборы правил

• WordPress — все правила WordPress
• WordPress-Core — правила для ядра WordPress
• WordPress-Docs — правила документирования
• WordPress-Extra — дополнительные правила, дополняющие правила WordPress-Core.
  Включают в себя WordPress-Core
• WordPress-VIP — правила WordPress VIP.
  Включают в себя WordPress-Core

Пример

phpcs --standard=WordPress wp-load.php // найдено 13 ошибок, 4 предупреждения

phpcbf --standard=WordPress wp-load.php // исправление ошибок phpcs --standard=WordPress wp-load.php // найдено 9 ошибок, 4 предупреждения