[WP] ウィジェット作成のデバッグ用にPHPConsoleを導入したが…

折角 WordPress に移行したのでウィジェットやプラグインを作ってみたいと思いやり始めたのですが、WordPress からどうやって API が呼ばれるのか、アクションフックの順序とか分からないことがありました。

こういう時は、デバッグをしたくなるのですが、標準のデバッグオプションだけでは、本当に必要な情報を確認できないのです。そこで Chrome でデバッグするための仕組みを探してみました。

結論から言うと別のツールを探すことにしましたが、お手軽なのでちょっとした調査なら使えるかもしれません。

PHPConsoleという拡張機能を試す

今回使ったのは PHPConsole という Chrome 拡張。詳細は以下のサイトで紹介されています。正確に知りたい方はご覧ください。

PHPConsole のオリジナルコードは Google Code で公開されています
PhpConsole.zip – php-console – PhpConsole class release v1.1 – Google Chrome extension for displaying PHP errors/exceptions/debug messages in browser console or notification popups – Google Project Hosting

使えるようにしてみよう

ここからはやったことを端折って説明します。

まずは、以下のサイトから Chrome 拡張をインストールします。
Chrome ウェブストア – PHP Console

次に PHPConsole for WordPress という WordPress 用プラグインを GitHub からダウンロードします。
bueltge/php-Console-for-WordPress

ここからZIPでダウンロードできます。ZIP でダウンロードしたら新規プラグインとしてアップロードして有効化します

あとは Debug したい PHP ファイルに

  debug("確認したいメッセージ");

1	debug("確認したいメッセージ");

というように書いたり、エラーが発生したりすると Chrome のデベロッパーツールにあるコンソールにその内容が出力されます。

PHPConsoleを使うかどうか

Chrome 拡張として使えそうなものは PHPConsole くらいしか見当たらなかったので試してみました。ちょっと動きが不安定なところがあって、Console にメッセージが表示されたり、されなかったりすることもありましたが、手軽に使えるという点では良いかもしれません。

また、プラグインになっているので、使わない時には無効にしておけば良いというのもお手軽です。(ウィジェットなどに debug コードを残して無効化すると管理画面のホワイトアウトが起こったりしますので注意してください。私は何回もハマりました)。

DebugBar というプラグインとバッティングしてしまうので、使う時は切り替える必要がある点に注意が必要なのと、昔ながらの Printf デバッグになる点が残念なので、他のツールも探してみようと思います。

行き着く先は、ローカルのMAMP上に入れてある PHP を Xdebug でフックするのかな、とも思っていますが、その辺りを試したら追々ご紹介したいな、と思います。