XDebugをDockerコンテナにインストールする

DockerfileにXDebugをインストールするコマンドを追加する。

# xdebug
RUN pecl install xdebug && \
    docker-php-ext-enable xdebug

php.iniにXDebug用の設定を追加する

Dockerコンテナにコピーするphp.iniにXDebug用の設定を追加する。

[xdebug]
xdebug.idekey = www-data
xdebug.max_nesting_level = 512
xdebug.remote_enable = On
xdebug.remote_autostart = On
xdebug.remote_host = host.docker.internal
xdebug.remote_port = 9000

Dockerコンテナを起動する

docker-compose up -d

PhpStormの設定を変更する

PhpStormのXDebug設定はプロジェクト毎に保存されるため各プロジェクトで設定が必要になる。

Preferences | Build, Execution, Deployment | Docker

下記は全プロジェクト共通のため一度だけ設定する。

  1. +ボタンをクリックして、Docker実行環境を追加する
  2. Connect to Docker daemon with:はDocker for Macを選択する

Preferences | Languages & Frameworks | PHP

  1. PHP language levelで使用しているPHPのバージョンを指定する
  2. CLI Interpreterの...をクリックする
    1. +ボタンをクリックしてからFrom Docker, Vagrant, VM, WSL, Remote...をクリックする
    2. Docker Composeを選択する
    3. Service:からPHP-FPMが実行されているサービスを選択する
    4. OKをクリックする
    5. LifecycleのConnect to existing containerを選択する
    6. OKをクリックする
  3. PHP Runtimeタブを選択する
  4. Sync Extensions with Interpreterをクリックする
  5. Applyをクリックする

Preferences | Languages & Frameworks | PHP | Debug

  1. Debug portをPHP-FPMの設定で指定したポート番号に合わせる
  2. Ignore external connections through unregistered server configurationsをチェックする
    • 外部からのデバッグ接続がサーバー構成に未登録の構成なら無視する
  3. Break at first lien in PHP scriptsをチェックする（設定に問題ないことが確認できてらチェックを外す）

Preferences | Languages & Frameworks | PHP | Servers

  1. +ボタンをクリックする
  2. Nameに好きな名前を入れる
  3. HostとPortはこのプロジェクトで起動したページにアクセスする時のホスト名とポート番号を入れる
  4. Use path mappingsにチェックを入れ、DockerコンテナにマウントされるローカルディレクトリのAbsolute path on the serverにマウント先のパスを入れる
  5. Applyをクリックする

Configuration

  1. 右上Add Configuration...をクリックする
  2. +ボタンをクリックしてからPHP Remote Debugを選択する
  3. Nameに好きな名前を入れる
  4. OKをクリックする

デバッグ実行する

Configurationsから上記で設定したものを選択し、Run > Debugを実行する。