修正 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中文網其他相關文章！