使用 PHP 8.x 处理 WordPress 项目时,您可能会遇到以下错误:
致命错误:未捕获 PHP_CodeSniffer\Exceptions\RuntimeException:trim():在 /path/... 中不推荐将 null 传递给字符串类型的参数 #1 ($string)
此错误是由于 PHP 8.x 中的弃用警告而发生的,其中不再允许将 null 传递给 trim() 函数。具体来说,此问题出现在 WordPress 编码标准 (WPCS) 嗅探中,该嗅探是 PHP_CodeSniffer 设置的一部分。截至撰写本文之日,即使使用最新版本的 PHP_CodeSniffer 和 WordPress 编码标准,此问题仍然存在。了解 PHP_CodeSniffer 和 WPCS
定影
例如,在文件
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 补丁
在patches/文件夹中,创建一个名为fix-null-trim.patch的新补丁文件。您可以使用文本编辑器执行此操作:
触摸补丁/fix-null-trim.patch
在文本编辑器中打开fix-null-trim.patch并添加以下内容:
// 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 将 PrefixAllGlobalsSniff.php 中的有问题的行替换为更安全的版本,该版本使用 null 合并运算符 (??) 以避免将 null 传递给trim()。
修改composer.json以应用补丁
打开项目的composer.json 文件。在“extra”部分下添加以下配置。如果“额外”部分尚不存在,您将需要创建它。
// 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 在安装或更新依赖项时将 fix-null-trim.patch 文件应用到 wp-coding-standards/wpcs 包。
安装 Composer 补丁插件
作曲家需要 cweagans/composer-patches
应用补丁
作曲家安装
在安装过程中,Composer 会将 patch/ 文件夹中的补丁应用到 PrefixAllGlobalsSniff.php 文件中。
通过创建和应用
补丁文件,您确保您的修复在Composer更新中持续存在,遵循软件开发的最佳实践。定期监控 PHP_CodeSniffer 和 WordPress 编码标准的更新,因为这些问题可能会在未来版本中得到解决。这种主动方法不仅可以提高代码质量,还可以改善您在 PHP 8.x 环境中的开发工作流程。
我已经在这个要点中共享了补丁文件。请随意使用它作为在您的项目中实施类似修复的参考!
免责声明: 提供的所有资源部分来自互联网,如果有侵犯您的版权或其他权益,请说明详细缘由并提供版权或权益证明然后发到邮箱:[email protected] 我们会第一时间内为您处理。
Copyright© 2022 湘ICP备2022001581号-3