修复 WordPress 编码标准中的 PHP_CodeSniffer Null Trim() 错误

在使用 PHP 8.x 处理 WordPress 项目时，您可能会遇到以下错误：

致命错误：未捕获 PHP_CodeSnifferExceptionsRuntimeException：trim()：在 /path/... 中不推荐将 null 传递给字符串类型的参数 #1 ($string)

此错误是由于 PHP 8.x 中的弃用警告而发生的，其中不再允许将 null 传递给 trim() 函数。具体来说，此问题出现在 WordPress 编码标准 (WPCS) 嗅探中，该嗅探是 PHP_CodeSniffer 设置的一部分。截至撰写本文之日，即使使用最新版本的 PHP_CodeSniffer 和 WordPress 编码标准，此问题仍然存在。

了解 PHP_CodeSniffer 和 WPCS

PHP_CodeSniffer 是一个工具，通过检查 PHP 代码是否违反指定规则来帮助开发人员维护编码标准。 WordPress 编码标准 (WPCS) 提供了一组在 WordPress 项目中编写一致且干净的代码的指南。上述错误通常表明由于 PHP 行为的变化，代码片段不符合这些标准。

定影

要解决此问题，我们可以手动修改导致问题的文件，找到调用trim()的行并更新代码以确保在调用trim()时正确处理空值。

例如，在文件 vendor/wp-coding-standards/wpcs/WordPress/Sniffs/NamingConventions/PrefixAllGlobalsSniff.php 中，找到第 280 行并替换以下行：

// this 
$cl_prefixes = trim( PHPCSHelper::get_config_data( 'prefixes' );

// to this 

$cl_prefixes = is_null( PHPCSHelper::get_config_data( 'prefixes' ) ) ? '' : trim( PHPCSHelper::get_config_data( 'prefixes' ) );

但是，正如软件开发中的许多决策一样，仅仅因为您可以这样做，并不意味着您应该。

虽然之前的方法可能会修复错误，但请务必记住修改供应商文件不是可持续的解决方案。每次通过 Composer 更新依赖项时，所做的更改都会丢失。

更好的方法是创建补丁文件。

创建补丁文件

这是有关如何针对该问题创建和应用补丁的分步指南

创建补丁文件

更强大的解决方案是创建补丁文件。此方法允许您在每次安装或更新依赖项时自动应用更改。

补丁文件是一个文本文件，其中包含文件两个版本之间的差异 - 本质上是“之前”和“之后”快照。

在您的项目目录中，创建一个文件夹来保存补丁文件：

mkdir -p 补丁

在 patch/ 文件夹中，创建一个名为 fix-null-trim.patch 的新补丁文件。您可以使用文本编辑器执行此操作：

触摸补丁/fix-null-trim.patch

在文本编辑器中打开 fix-null-trim.patch 并添加以下内容：

  --- a/vendor/wp-coding-standards/wpcs/WordPress/Sniffs/NamingConventions/PrefixAllGlobalsSniff.php
+++ b/vendor/wp-coding-standards/wpcs/WordPress/Sniffs/NamingConventions/PrefixAllGlobalsSniff.php
@@ -280,7 +280,7 @@

        // Original code with `trim()`
        // Update this line:
-       $cl_prefixes = trim( PHPCSHelper::get_config_data( 'prefixes' ) );
+       $cl_prefixes = is_null( PHPCSHelper::get_config_data( 'prefixes' ) ) ? '' : trim( PHPCSHelper::get_config_data( 'prefixes' ) );

--- a/vendor/wp-coding-standards/wpcs/WordPress/Sniffs/WP/I18nSniff.php
+++ b/vendor/wp-coding-standards/wpcs/WordPress/Sniffs/WP/I18nSniff.php
@@ -194,7 +194,7 @@

        // Original code with `trim()`
        // Update this line:
-       $cl_text_domain = trim( PHPCSHelper::get_config_data( 'text_domain' ) );
+       $cl_text_domain = is_null(PHPCSHelper::get_config_data( 'text_domain' )) ? '' : trim( PHPCSHelper::get_config_data( 'text_domain' ) );

--- a/vendor/wp-coding-standards/wpcs/WordPress/Sniffs/Sniff.php
+++ b/vendor/wp-coding-standards/wpcs/WordPress/Sniffs/Sniff.php
@@ -1144,7 +1144,7 @@

        // Original code with `trim()`
        // Update this line:
-       $cl_supported_version = trim( PHPCSHelper::get_config_data( 'minimum_supported_wp_version' ) );
+       $cl_supported_version = is_null(PHPCSHelper::get_config_data( 'minimum_supported_wp_version' )) ? '' : trim( PHPCSHelper::get_config_data( 'minimum_supported_wp_version' ) );

此补丁告诉 Composer 将 PrefixAllGlobalsSniff.php 中的有问题的行替换为更安全的版本，该版本使用 null 合并运算符 (??) 以避免将 null 传递给 trim()。

修改composer.json以应用补丁

接下来，您需要指示 Composer 在您安装或更新依赖项时自动应用此补丁。

打开项目的composer.json 文件。在“extra”部分下添加以下配置。如果“额外”部分尚不存在，您将需要创建它。

    json

    "extra": {
        "patches": {
            "wp-coding-standards/wpcs": {
                "Fix null trim() issue": "patches/fix-null-trim.patch"
            }
        }
    }

这告诉 Composer 在安装或更新依赖项时将 fix-null-trim.patch 文件应用到 wp-coding-standards/wpcs 包。

安装 Composer 补丁插件

要通过Composer应用补丁，您需要composer-patches插件。运行以下命令进行安装：

作曲家需要 cweagans/作曲家补丁

应用补丁

现在，您可以通过运行以下命令来应用补丁：

作曲家安装

在安装过程中，Composer 会将 patch/ 文件夹中的补丁应用到 PrefixAllGlobalsSniff.php 文件中。

通过创建和应用补丁文件，您确保您的修复在Composer更新中持续存在，遵循软件开发的最佳实践。定期监控 PHP_CodeSniffer 和 WordPress 编码标准的更新，因为这些问题可能会在未来版本中得到解决。这种主动方法不仅可以提高代码质量，还可以改善 PHP 8.x 环境中的开发工作流程。

我已经在这个要点中分享了补丁文件。请随意使用它作为在您的项目中实施类似修复的参考！

以上是修复 WordPress 编码标准中的 PHP_CodeSniffer Null Trim() 错误的详细内容。更多信息请关注PHP中文网其他相关文章！