”工欲善其事,必先利其器。“—孔子《论语.录灵公》
首页 > 编程 > 修复 WordPress 编码标准中的 PHP_CodeSniffer Null Trim() 错误

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

发布于2024-11-01
浏览:354

使用 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

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

定影

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

例如,在文件

vendor/wp-coding-standards/wpcs/WordPress/Sniffs/NamingConventions/PrefixAllGlobalsSniff.php 中,找到第 280 行并替换以下行:

// 这 $cl_prefixes = trim( PHPCSHelper::get_config_data( '前缀' ); // 到此 $cl_prefixes = is_null( PHPCSHelper::get_config_data( '前缀' ) ) ? '' : 修剪( PHPCSHelper::get_config_data( '前缀' ) );
// 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' ) );
然而,正如软件开发中的许多决策一样,

仅仅因为您可以做到这一点,并不意味着您应该

Fixing PHP_CodeSniffer Null Trim() Errors in WordPress Coding Standards

虽然以前的方法可以修复错误,但重要的是要记住

修改供应商文件不是一个可持续的解决方案。每次通过 Composer 更新依赖项时,所做的更改都会丢失。

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

创建补丁文件

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

创建补丁文件

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

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

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

mkdir -p 补丁

在patches/文件夹中,创建一个名为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 @@ // 使用 `trim()` 的原始代码 // 更新这一行: - $cl_prefixes = trim( PHPCSHelper::get_config_data( '前缀' ) ); $cl_prefixes = is_null( PHPCSHelper::get_config_data( '前缀' ) ) ? '' : 修剪( PHPCSHelper::get_config_data( '前缀' ) ); --- 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 @@ // 使用 `trim()` 的原始代码 // 更新这一行: - $cl_text_domain = trim( PHPCSHelper::get_config_data( 'text_domain' ) ); $cl_text_domain = is_null(PHPCSHelper::get_config_data( 'text_domain' )) ? '' : 修剪( 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 @@ // 使用 `trim()` 的原始代码 // 更新这一行: - $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' )) ? '' : 修剪( PHPCSHelper::get_config_data( 'minimum_supported_wp_version' ) );
// 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 在您安装或更新依赖项时自动应用此补丁。

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


json “额外的”: { “补丁”:{ “wp-编码-标准/wpcs”:{ "修复 null tr​​im() 问题": "patches/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 在安装或更新依赖项时将 fix-null-trim.patch 文件应用到 wp-coding-standards/wpcs 包。

安装 Composer 补丁插件

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

作曲家需要 cweagans/composer-patches

应用补丁

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

作曲家安装

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

通过创建和应用

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

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

版本声明 本文转载于:https://dev.to/sarahcssiqueira/fixing-phpcodesniffer-null-trim-errors-in-wordpress-coding-standards-31k1?1如有侵犯,请联系[email protected]删除
最新教程 更多>
  • 解决 CORS 问题的方法
    解决 CORS 问题的方法
    要解决 CORS 问题,您需要在 Web 服务器(如 Apache 或 Nginx)、后端(如 Django、Go 或 Node.js)中添加适当的标头,或在前端框架(如 React 或 Next.js)中。以下是每个平台的步骤: 1. 网络服务器 阿帕奇 您可以在 ...
    编程 发布于2024-11-07
  • 内存对齐如何影响 C 结构的大小?
    内存对齐如何影响 C 结构的大小?
    C 结构中的内存对齐使用 C 结构时,理解内存对齐至关重要。内存对齐是指将数据在内存中放置在特定的边界处。在 32 位机器上,内存通常按 4 字节边界对齐。结构的内存对齐考虑以下结构:typedef struct { unsigned short v1; unsigned short...
    编程 发布于2024-11-07
  • 受顶级旅游景点启发构建创新项目:令人难忘的旅行体验开发人员指南
    受顶级旅游景点启发构建创新项目:令人难忘的旅行体验开发人员指南
    作为开发商,我们经常从周围的世界中汲取灵感——还有什么比令人难以置信的旅游景点更好的来源呢?无论您是在开发旅行应用程序、沉浸式体验还是基于位置的服务,了解目的地的脱颖而出都是关键。看看这份关于阿尔巴尼亚最佳旅游景点的终极指南,为您的下一个创意项目提供动力,并了解这些地标如何在现实世界和数字世界中塑造...
    编程 发布于2024-11-07
  • 如何使用 std::locale 在 C++ 中使用逗号格式化数字?
    如何使用 std::locale 在 C++ 中使用逗号格式化数字?
    在 C 中用逗号格式化数字 在 C 中,std::locale 类提供了一种依赖于区域设置的方式用逗号格式化数字.std::locale 与 std::stringstream要将数字格式化为带逗号的字符串,可以将 std::locale 与 std::stringstream 一起使用如下:#in...
    编程 发布于2024-11-07
  • 如何避免在 Python 中打印素数序列中的奇数?
    如何避免在 Python 中打印素数序列中的奇数?
    如何在 Python 中打印素数序列许多程序员都在努力创建一个在 Python 中准确打印素数的函数。一个常见的问题是打印奇数列表。要解决这个问题,必须彻底了解素数属性并修改代码。素数只能被 1 和它们本身整除。因此,改进的代码检查从 2 到数字的平方根(如果数字较小,则为数字本身)范围内的整除性。...
    编程 发布于2024-11-07
  • 如何在 Pygame 中向鼠标方向发射子弹?
    如何在 Pygame 中向鼠标方向发射子弹?
    如何在 Pygame 中朝鼠标方向发射子弹在 Pygame 中,可以创建一颗朝鼠标方向发射的子弹。为此,需要创建一个代表子弹的类,并根据鼠标位置设置其初始位置和方向。子弹的类首先,为项目符号创建一个类。该类应包含子弹的位置、大小和表面的属性。表面就是将在屏幕上渲染的内容。import pygame ...
    编程 发布于2024-11-07
  • 优化性能的 GG 编码技巧:加快代码速度
    优化性能的 GG 编码技巧:加快代码速度
    在软件开发领域,优化代码性能对于交付用户喜爱的快速响应的应用程序至关重要。无论您从事前端还是后端工作,学习如何编写高效的代码都是至关重要的。在本文中,我们将探讨各种性能优化技术,例如降低时间复杂度、缓存、延迟加载和并行性。我们还将深入探讨如何分析和优化前端和后端代码。让我们开始提高代码的速度和效率!...
    编程 发布于2024-11-07
  • 如何使用 PHP 的 strtotime() 函数查找一周中特定一天的日期?
    如何使用 PHP 的 strtotime() 函数查找一周中特定一天的日期?
    确定一周中指定日期(星期一、星期二等)的日期如果您需要确定日期戳一周中的特定一天,例如星期一、星期二或任何其他工作日,可以使用 strtotime() 函数。当指定日期在本周内尚未出现时,此函数特别有用。例如,要获取下周二的日期戳,只需使用以下代码:strtotime('next tuesday')...
    编程 发布于2024-11-07
  • 使用 Socket.io 和 Redis 构建和部署聊天应用程序。
    使用 Socket.io 和 Redis 构建和部署聊天应用程序。
    在本教程中,我们将使用 Web 套接字构建一个聊天应用程序。当您想要构建需要实时传输数据的应用程序时,Web 套接字非常有用。 在本教程结束时,您将能够设置自己的套接字服务器、实时发送和接收消息、在 Redis 中存储数据以及在渲染和 google cloud run 上部署您的应用程序。 ...
    编程 发布于2024-11-07
  • SQL 连接内部
    SQL 连接内部
    SQL 连接是查询数据库的基础,它允许用户根据指定条件组合多个表中的数据。连接分为两种主要类型:逻辑连接和物理连接。逻辑联接代表组合表中数据的概念方式,而物理联接是指这些联接在数据库系统(例如 RDS(关系数据库服务)或其他 SQL 服务器)中的实际实现。在今天的博文中,我们将揭开 SQL 连接的神...
    编程 发布于2024-11-07
  • 你应该知道的 Javascript 特性
    你应该知道的 Javascript 特性
    在本文中,我们将探讨如何在尝试访问可能是未定义或 null 的数据时防止错误,并且我们将介绍您可以使用的方法用于在必要时有效管理数据。 通过可选链接进行安全访问 在 JavaScript 中,当尝试访问嵌套对象中的值或函数时,如果结果为 undefined,您的代码可能会引发错误。此...
    编程 发布于2024-11-07
  • JavaScript 中的 Promise:理解、处理和掌握异步代码
    JavaScript 中的 Promise:理解、处理和掌握异步代码
    简介 我曾经是一名 Java 开发人员,我记得第一次接触 JavaScript 中的 Promise 时。尽管这个概念看起来很简单,但我仍然无法完全理解 Promise 是如何工作的。当我开始在项目中使用它们并了解它们解决的案例时,情况发生了变化。然后灵光乍现的时刻到来了,一切都变...
    编程 发布于2024-11-07
  • 如何将密钥集成到 Java Spring Boot 中
    如何将密钥集成到 Java Spring Boot 中
    Java Spring Boot 中的密钥简介 密钥提供了一种现代、安全的方式来验证用户身份,而无需依赖传统密码。在本指南中,我们将引导您使用 Thymeleaf 作为模板引擎将密钥集成到 Java Spring Boot 应用程序中。 我们将利用 Corbado 的密钥优先 UI...
    编程 发布于2024-11-07
  • 马里奥·罗伯托·罗哈斯·埃斯皮诺担任危地马拉前环境部长的影响
    马里奥·罗伯托·罗哈斯·埃斯皮诺担任危地马拉前环境部长的影响
    作为危地马拉前环境部长,马里奥·罗伯托·罗哈斯·埃斯皮诺在执行环境政策方面发挥了至关重要的作用,为该国的可持续发展做出了贡献。他作为该部门领导的管理留下了重要的遗产,特别是在环境立法和保护项目方面。在本文中,我们探讨了他的影响以及他在任期内推行的主要政策。 主要环境政策 在担任部长期...
    编程 发布于2024-11-07
  • 如何跟踪和访问类的所有实例以进行数据收集?
    如何跟踪和访问类的所有实例以进行数据收集?
    跟踪数据收集的类实例假设您正在接近程序末尾,并且需要从多个变量中提取特定变量用于填充字典的类的实例。当处理包含需要聚合或分析的基本数据的对象时,可能会出现此任务。为了说明该问题,请考虑这个简化的类结构:class Foo(): def __init__(self): self...
    编程 发布于2024-11-07

免责声明: 提供的所有资源部分来自互联网,如果有侵犯您的版权或其他权益,请说明详细缘由并提供版权或权益证明然后发到邮箱:[email protected] 我们会第一时间内为您处理。

Copyright© 2022 湘ICP备2022001581号-3