phpstan wordpress

Важный

Всем привет! Это Виктор, который управляет этим расширением PHPSTAN. Я планирую прекратить участие в экосистеме WordPress, потому что она чрезвычайно сложно, и никто не просит меня присоединиться к его команде, поскольку я мыслитель, человек DevOps, производитель инструментов (не строитель).

Пожалуйста, поддержите мою работу, чтобы избежать отказа от этого пакета.

Спасибо!

Расширения WordPress для Phpstan

Статический анализ экосистемы WordPress.

• Phpstan
• WordPress

Функции

• Позволяет PHPSTAN анализировать плагины WordPress и темы.
• Загружает пакет php-stubs/wordpress-stubs .
• Предоставляет динамические расширения типа возврата для функций, которые не охватываются в php-stubs/wordpress-stubs
• Определяет некоторые константы ядра WordPress.
• Проверивает необязательные Docblocks перед apply_filters() и do_action() вызовы, рассматривая тип первого @param как окончательным.

Требования

• Phpstan 2.0 или выше
• PHP 7,4 или выше (протестировано до PHP 8,3)

Установка

Чтобы использовать это расширение, требовать его в композиторе:

composer require --dev szepeviktor/phpstan-wordpress

Если вы также установите Phpstan/Extension-Installer, то вы все настроены!

Ручная установка

Если вы не хотите использовать phpstan/extension-installer , включите extension.neon в конфигурации вашего проекта Phpstan:

 includes :
    - vendor/szepeviktor/phpstan-wordpress/extension.neon 

Конфигурация

Никакой дополнительной настройки не требуется. ? Просто настройте Phpstan - например - как показано ниже:

 parameters :
    level : 5
    paths :
        - plugin.php
        - inc/

Для получения более подробной информации посетите ссылку на конфигурацию PHPSTAN.

Используйте Composer AutoLoAloader или пользовательский автозагрузчик!

Использование

Запустите анализ с:

vendor/bin/phpstan analyze

Затем исправьте ошибку и GOTO 10 !

Вы находите дополнительную информацию в каталоге examples , например examples/phpstan.neon.dist

Использование в веб -магазинах WooCommerce

Обратитесь к Woocommerce Stubs для конкретного руководства.

Использование Docblock apply_filters()

Экосистема WordPress часто использует Docblocks PHPDOC нестандартным способом для документирования параметров, передаваемых apply_filters() . Вот пример:

 /**
 * Filters the page title when creating an HTML drop-down list of pages.
 *
 * @param string  $title Page title.
 * @param WP_Post $page  Page data object.
 */
$ title = apply_filters ( ' list_pages ' , $ title , $ page );

Это расширение гласит эти Docblocks и инструктирует Phpstan рассматривать тип возврата фильтра как определенным, основываясь на первом теге @param . В этом примере Phpstan интерпретирует $title как string .

Для достижения наилучших результатов убедитесь, что первый тег @param в этих Docblocks является точным.

Сделайте ваш код тестируемым

• Запишите Clean OOP -код: 1 класс на файл, и нет дополнительного кода за пределами class Name { ... } .
• Используйте последовательное именование классов (WPCS или PSR-4) и храните классы в специализированном каталоге inc/ .
• Добавьте точные блоки PhpDoc в классы, свойства, методы, функции и вызовы apply_filters() .
• Выберите свои основные детали файла плагина.
• Избегайте использования константы ядра, используйте основные функции.
• Избегайте плохих практик PHP, таких как:
  • Функции: eval , extract , compact , list
  • Тип жонглирования: $a = '15'; if ($a) ...
• Если вам нужен надежный код, попробуйте избегать всех видов жонглирования типа (например, if вам нужна логическая), см. Функции обработки переменных
• Избегайте включения exit_error в WP_CLI::launch или WP_CLI::runcommand для улучшения тестируемости.

Грязный угол (FAQ)

WordPress использует условную функцию и определение класса, чтобы разрешить переопределение. Используйте команду sed , чтобы исключить заглушки функций, когда они определены ранее.

sed -i -e ' s#function is_gd_image#function __is_gd_image# ' vendor/php-stubs/wordpress-stubs/wordpress-stubs.php