本記事では、
peclを使って、XdebugをローカルPC(MacBook)にインストールした時の手順を紹介する。
別にmacでなくてもpeclを使った手順はどのPCでも大体一緒だと思うので参考にしてほしい。
peclを使って、Xdebugインストールする手順
では本題、
peclを使って、Xdebugをインストールする手順を解説していく。
具体的には以下の様なステップでXdebugをインストールしていく
- peclでXdebugをインストール
- php.iniの設定変更
- apacheを再起動
- ※確認作業:phpinfo()を表示
では順に解説していく。
①peclでXdebugをインストール
Xdebugのインストールはpeclと言うコマンドを使用して実施する。

peclとは、phpの拡張モジュールをインストールしてくれるサービスだ。
PECLは、PHPで利用できる拡張ライブラリを提供しているサービス。
PECLにより提供されるライブラリはPHPの拡張モジュールとしてインストールされる。
Xdebugもphpの拡張モジュールなので、peclでインストールすることができる。
ちなみにpeclはphpをインストールすると一緒に入っている。
which pecl
/usr/local/bin/pecl
下記peclコマンドをターミナルにて実行し、Xdebugをインストールする。
# peclでxdebugをインストール
pecl install xdebug
インストールが完了すると以下のような文言が表示されるので、
赤枠部分をメモ帳などに残して置いて欲しい。後に使用する。

②php.iniの設定変更
Xdebugは、実はインストールしただけでは動いてくれない。
動くようにするには、php.iniの設定ファイルを修正する必要がある。
php.iniをviエディタ等で開き、下記の設定を追記する。
大抵、php.iniの際末尾に、以下のフォーマットで記述する。
#php.ini
[xdebug]
zend_extension="メモったxdebugのパス"
xdebug.remote_enable=1
xdebug.remote_host="localhost"
xdebug.remote_port=9000
xdebug.profiler_enable=1
「zend_extension」と書いてあるところには、先ほどメモったxdebugのパスを記入する。

追記したら、保存して閉じてOK
関連記事として、php.iniの設定値を理解すると言うテーマで執筆した記事があるので、そちらもよければ合わせて購読していただけるとより理解が深まるはずだ。
③apacheを再起動
上記が終了したらapacheを再起動する。
これをやらずに筆者は30分くらいハマった
// apacheを再起動
brew services restart httpd
④※確認作業:phpinfo()を表示
Xdebugのインストール動作確認として、
phpinfo()と書いただけのphpファイルにアクセスする。


phpinfo()の画面で「xdebug」のセクションが表示されていれば正しくxdebugが動いている。

以上でpeclを使ってXdebugをインストールする手順は終了である。
おまけ:Xdebugとは?

Xdebugとは、phpの拡張モジュールのことだ。
phpソースのデバッグを簡単にしてくれる機能を持つ。
Xdebugの使用例
例えば以下のように、配列の中身を出力し、
Xdebugが入っていない場合(上)とXdebugが入っている場合(下)を見比べてみる。
xdebugなし
xdebugあり
debugが入っていない場合(上)と比べて、Xdebugが入っている場合(下)の方が、圧倒的に出力結果が見やすくなっているのが分かるだろう。
このように、、Xdebugを導入すると、phpのデバッグ効率が向上すると言うメリットがあるため、ぜひphp開発者の方は、Xdebugの導入をするべきである。
xdebug動作確認
冒頭でも見たプログラムを画面に表示してみよう。
以下のプログラムを記述した「test.php」にアクセス
#test.php
<?php
$test = ['a' => 'aaa', 'b' => 'bbb', 'c' => 'ccc'];
var_dump($test);
?>
以下のような画面が表示されればOK。
変数の中身(配列)がxdebugのおかげでわかりやすく表示されている。

関連記事
https://www.php.net/manual/ja/configuration.file.php
https://www.php.net/manual/ja/install.pecl.php