【簡単】PhpStormでXdebugを設定

こんにちは、新米エンジニアの宮城です。
今回は、PhpStormでXdebugの設定を紹介します。

環境

  • Docker v20.10.14
  • MacBook Pro (M1)
  • PHP v8.1.6
  • ※Docker、Xdebug、 PhpStormが使用可能となっている前提です。

手順

下記の手順で進めていきます。

  • Xdebugがインストールされているか確認
  • Xdebug.ini の設定
  • 設定の確認
  • PhpStormの設定
  • Debug実行設定
  • Xdebugの実行

Xdebugがインストールされているか確認

コンテナ内に入り、下記を実行します。

コンテナに入る
$ docker container exec -it コンテナ名 bash

インストールされているモジュールの一覧が表示される
$ php -m

出力結果
[Zend Modules]
Xdebug

※表示されない場合は、Xdebugをインストールしてください。

(https://pleiades.io/help/phpstorm/configuring-xdebug.html)

Xdebug.ini の設定(Xdebug3系)

[xdebug]
xdebug.mode =debug
xdebug.start_with_request =yes
xdebug.client_host =host.docker.internal
xdebug.discover_client_host =1
xdebug.idekey=PHPSTORM
xdebug.client_port=9003
xdebug.log_level=0
xdebug.log=/tmp/xdebug.log

※Xdebug2系と3系では設定が異なるので注意してください。

設定後は、コンテナを再起動しましょう。

設定の確認

phpinfo();で確認します。

PhpStormの設定

PhpStormでプロジェクトを開いて、Preferences>PHP>Xdebugを開きます。

デバックポートが 90003(9000でも可)で、「Can accept external connections(外部接続を受け入れる)」がチェックされていることを確認します。

サーバーを追加するために、Preferences>PHP>サーバーを開いて、設定します。

Debug実行設定

サーバー名等を設定する

「OK」をクリックし、設定完了です。

Xdebugの実行

まとめ

設定は大変!と感じてdd();など他にもデバック方法がありますが、Xdebugが使えるとすごく便利なので、参考にしていただけると嬉しいです。

参考記事

\フリーランス制作パートナー募集/

弊社パートナーとして、クリエイティブ制作・システム開発等、各分野で協力しあえるフリーランスのパートナー様を募集しております。詳細等、下記のフォームよりお気軽にお問い合わせくださいませ。スタッフ一同、パートナーシップを構築出来る方との出会いを楽しみにしております。

Related article

おすすめ関連記事