phpstan wordpress

重要的

大家好！这是维克多（Viktor），他运行了这个phpstan扩展名。我计划停止为WordPress生态系统做出贡献，因为这非常困难，没有人要求我加入他的团队，因为我是一个思想家，一个Devops的人，工具制造商（不是建造者）。

请支持我的工作，以避免放弃此包裹。

谢谢你！

phpstan的WordPress扩展

WordPress生态系统的静态分析。

• phpstan
• WordPress

特征

• 使Phpstan能够分析WordPress插件和主题。
• 加载php-stubs/wordpress-stubs软件包。
• 提供动态返回类型扩展名，用于未覆盖的php-stubs/wordpress-stubs功能
• 定义一些WordPress核心常数。
• 在apply_filters()和do_action()调用之前验证可选的DocBlocks，将第一个@param的类型视为确定性。

要求

• phpstan 2.0或更高
• PHP 7.4或更高（测试最高为PHP 8.3）

安装

要使用此扩展名，请在作曲家中需要它：

composer require --dev szepeviktor/phpstan-wordpress

如果您还安装了phpstan/Extension-installer，那么您将全部设置！

手动安装

如果您不想使用phpstan/extension-installer ，请在项目的PHPSTAN配置中包含extension.neon ：

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

配置

无需其他设置。 ？只需配置phpstan-例如 - 如下所示：

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

有关更多详细信息，请访问PHPSTAN配置参考。

使用作曲家自动加载器或自定义自动加载器！

用法

运行分析：

vendor/bin/phpstan analyze

然后修复错误并GOTO 10 ！

您在examples目录中找到更多信息，例如examples/phpstan.neon.dist

在WooCommerce网络商店中使用

有关特定的指导，请参阅WooCommerce存根。

使用apply_filters() dicblock的用法

WordPress生态系统通常以非标准的方式使用PHPDOC Docblocks来记录传递给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 );

此扩展程序读取这些放置的模块，并指示PHPSTAN根据第一个@param标签将过滤器的返回类型视为确定的。在此示例中，phpstan将$title解释为string 。

为了获得最佳效果，请确保这些Docblocks中的第一个@param标签准确。

使您的代码可测试

• 编写清洁的OOP代码：每个文件1类，并且在class Name { ... }外部没有其他代码。
• 使用一致的类命名（WPC或PSR-4），并在专用inc/ Directory中存储类。
• 将精确的phpdoc块添加到类，属性，方法，功能和apply_filters()调用中。
• 选择您的主插件文件零件。
• 避免使用核心常数，使用核心功能。
• 避免使用不良的PHP实践，例如：
  • 功能： eval ， extract ， compact ， list
  • 类型杂耍： $a = '15'; if ($a) ...
• 如果您需要强大的代码，请尝试避免使用各种类型的杂耍（例如， if需要布尔值），请参见变量处理功能
• 避免在WP_CLI::launch或WP_CLI::runcommand中启用exit_error ，以提高可测试性。

肮脏的角（常见问题解答）

WordPress使用条件函数和类定义来允许覆盖。先前定义的sed命令将其排除函数存根。

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