PhpStorm の WP-CLI コマンドラインツールを使用する

Composer を使用して WP-CLI パッケージをインストールする

1. composer.json 内で、wp-cli/wp-cli 依存関係レコードを require キーまたは require-dev キーに追加します。パッケージ名とバージョンのコード補完を取得するには、Ctrl+Space を押します。

2. 以下のいずれか 1 つを実行します:

   • エディターパネルの上部にあるインストールショートカットリンクをクリックします。

   • インストールされていない Composer パッケージインスペクションが有効になっている場合、PhpStorm は、現在インストールされていない宣言済みの依存関係をハイライトします。Alt+Enter を押して、特定の依存関係をインストールするか、すべての依存関係を一度にインストールするかを選択します。

コマンドラインツールとして WP-CLI を設定する

1. 設定ダイアログ（Ctrl+Alt+S）で、ツール | PHP コマンドラインツールのサポートに移動します。

2. ツールバーの をクリックします。

3. コマンドラインツールダイアログで、リストから WP-CLI を選択し、その可視性レベル（プロジェクトまたはグローバル）を指定します。

   

4. OK をクリックすると、WP-CLI ダイアログが開きます。

   WP-CLI を実行する方法を選択してください。

   • PHAR 経由でインストール : PHP スクリプトを介して WordPress を起動するか、PhpStorm に wp-cli.phar アーカイブ内のランチャーを検出して起動させるには、このオプションを選択します。

     PHP インタープリターリストから構成済みの PHP インタープリターの 1 つを選択します。詳細については、「ローカル PHP インタープリターを構成するおよびリモート PHP インタープリターの構成」を参照してください。

     phar への道フィールドで、wp-cli.phar アーカイブの場所を指定します。パスを手動で入力するか、 をクリックして表示されるダイアログで目的の場所を選択します。

   • 実行可能ファイル (Composer などを介してインストール) : このオプションを選択すると、パッケージ管理ツール（Composer など）を使用して WordPress をインストールしたときに使用可能な実行可能ファイルを介して WordPress を起動します。

     wp.bat へのパスフィールドで、wp.bat または wp 実行可能ファイルの場所を指定します。Composer を使用した場合、デフォルトの場所は \vendor\wp\cli\bin\wp または \vendor\wp\cli\bin\wp.bat です。パスを手動で入力するか、 をクリックして表示されるダイアログで目的の場所を選択します。

5. 「OK」をクリックして変更を適用し、「PHP コマンドラインツールのサポート」ページに戻ります。必要に応じて、 をクリックしてツールのプロパティを編集するか、 をクリックしてコマンドセットをカスタマイズします。詳細については、ツールをカスタマイズするを参照してください。

WP-CLI コマンドを実行する

他のコマンドラインツールのコマンドと同様に、WP-CLI コマンドを実行し、その出力を PhpStorm で直接分析できます。PHP コマンドラインツールを参照してください。

• ツール | コマンドの実行に移動するか、Ctrl を 2 回押します。

  開いたなんでも実行ウィンドウで、<wp> <command> 形式でコマンドの呼び出しを入力します。

  コマンドの実行結果は実行ツールウィンドウに表示されます。

  

コマンドを終了する

• 実行ツールウィンドウツールバーの をクリックします。

WP-CLI コマンドのデバッグ

Wordpress コマンドは、WP_CLI_Command を拡張するコントローラークラスと任意の関数で定義されます。コマンドをデバッグするには、コントローラークラスやコマンドが定義されているファイルではなく、コマンド自体のデバッグセッションを開始することが重要です。そうしないと、Wordpress ブートストラッププロセスがスキップされ、実行が失敗します。

1. 選択したコマンドに対応するコントローラークラスまたはファイルで、ブレークポイントを設定するコード行でエディターのガターをクリックします。

   

2. 選択したコマンドで wp-cli ツールを実行する実行 / デバッグ構成を作成します。メインメニューで、実行 | 実行構成の編集に移動し、 をクリックして、リストから PHP スクリプトを選択します。

   

3. PHP スクリプトダイアログで、実行 / デバッグ構成パラメーターを指定します。

   • ファイルフィールドに、wp-cli 実行可能ファイルへのパスを指定します。

   • 引数フィールドに、my-command print_year などの実際のコマンドとその引数を入力します。

   

4. PhpStorm ツールバーで、作成された実行 / デバッグ構成を選択し、 をクリックします。コマンドの実行は、指定されたブレークポイントで停止します。