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