phpstan wordpress

重要

こんにちは、みんな！これは、このphpstan拡張機能を実行するViktorです。 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 configにextension.neonを含めます。

 includes :
    - vendor/szepeviktor/phpstan-wordpress/extension.neon 

構成

追加のセットアップは必要ありません。 ？以下に示すように、phpstanを構成するだけです。

 parameters :
    level : 5
    paths :
        - plugin.php
        - inc/

詳細については、PHPSTAN Config Referenceをご覧ください。

Composer Autoloaderまたはカスタムオートローダーを使用してください！

使用法

分析を実行します：

vendor/bin/phpstan analyze

次に、エラーを修正し、 GOTO 10 ！

詳細情報は、 examplesディレクトリ、 examples/phpstan.neon.distなど

WooCommerce WebShopsでの使用

特定のガイダンスについては、WooCommerceスタブを参照してください。

apply_filters() docblockの使用

WordPressエコシステムは、多くの場合、PHPDOCドックブロックを非標準の方法で使用して、 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 );

この拡張機能は、これらのdocblocksを読み取り、最初の@paramタグに基づいて、フィルターのリターンタイプを確実に扱うようにphpstanに指示します。この例では、phpstanは$title stringとして解釈します。

最良の結果を得るには、これらのdocblockの最初の@paramタグが正確であることを確認してください。

コードをテスト可能にします

• クリーンOOPコードを書き込む：ファイルごとに1つのクラス、およびclass Name { ... }の外側の追加コードはありません。
• 一貫したクラスの命名（WPCSまたはPSR-4）を使用し、専用のinc/ディレクトリにクラスを保存します。
• クラス、プロパティ、メソッド、関数、およびapply_filters()呼び出しに正確なphpdocブロックを追加します。
• メインプラグインファイルパーツを選択します。
• コア定数の使用を避け、コア関数を使用します。
• 次のような悪いPHPプラクティスを避けてください。
  • 関数： eval 、 extract 、 compact 、 list
  • タイプジャグリング： $a = '15'; if ($a) ...
• 堅牢なコードが必要な場合は、あらゆる種類のタイプジャグリングを回避してみてください（たとえば、ブール値が必要なif ）、変動処理機能を参照してください
• WP_CLI::launchまたはWP_CLI::runcommandでexit_error有効にしないでください。

ダーティコーナー（FAQ）

WordPressは、条件付き関数とクラスの定義を使用して、オーバーライドを可能にします。 sedコマンドを使用して、以前に定義されたときに関数スタブを除外します。

sed -i -e ' s#function is_gd_image#function __is_gd_image# ' vendor/php-stubs/wordpress-stubs/wordpress-stubs.php