こんにちは、さるまりんです。
WordPressを使っていて、
「なんだか動かない」
「画面がおかしくなった」
「プラグインを変えたらエラーになった」
ということがあります。
(あって欲しくなくてもあります。)
でも、
何が起きているのかわからない。
そんなとき、原因を探す手がかりが欲しいです。
今回は、
WP_DEBUG_LOG
を使って、WordPressのエラーをログに残してみます。
まずはwp-config.phpを見ます
WordPressには、
wp-config.php
という設定ファイルがあります。
デバッグの設定も、このファイルに書くことができます。
ただし、いきなり追加する前に、
WP_DEBUG
という文字がすでに書かれていないか探してみます。
例えば、
define( 'WP_DEBUG', false );
のような設定があるかもしれません。
サイトによって、ここが少し違っていることもあります。
まずは今どうなっているのかを確認してみましょう。
変更する前に、元の wp-config.php のバックアップも取っておきます。
ログを残す設定にしてみます
エラーをログに残すには、例えばこんな設定にします。
define( 'WP_DEBUG', true );
define( 'WP_DEBUG_LOG', true );
define( 'WP_DEBUG_DISPLAY', false );
それぞれを簡単に見ると、
WP_DEBUG
→ デバッグを有効にする
WP_DEBUG_LOG
→ エラーをログに残す
WP_DEBUG_DISPLAY
→ エラーを画面に表示するかどうか
という感じです。
今回は、
define( 'WP_DEBUG_DISPLAY', false );
にしているので、WordPress側ではエラーを画面に出さず、ログで確認する設定にしています。
画面いっぱいにエラーが表示されるより、この方が確認しやすい場合もありますね。
なお、サーバー側のPHPの設定も画面表示に関係することがあります。
「falseにしたのに表示される」
という場合には、PHP側の設定も確認してみましょう。
ログはどこにできる?
通常、
define( 'WP_DEBUG_LOG', true );
にすると、
wp-content/debug.log
にログが保存されます。
何かエラーや警告が起きたあとに、
wp-content
の中を見て、
debug.log
ができているか確認します。
記録するエラーがなければ、まだファイルができていないこともあります。
その中を見ると、
「どのファイルで」
「どんなエラーが起きたのか」
といった、原因を探すための情報が残っていることがあります。
ログの置き場所には少し注意
ここで少し気になることがあります。
wp-content/debug.log
はWordPressの標準の保存先です。
ただ、ログにはファイルの場所やエラーの内容など、外から見せたくない情報が入ることがあります。
公開しているサイトでは、
ログそのものを外から簡単に見られないようにする
ことも大切です。
WP_DEBUG_LOG には、true の代わりに保存するファイルの絶対パスを指定することもできます。
例えば、
define( 'WP_DEBUG_LOG', '/path/to/private/wp-debug.log' );
のような形です。
これは書き方の例なので、そのままでは使えません。実際には、自分が使っているサーバーで確認した絶対パスを指定します。~/logs/ のようなホームの省略表記ではなく、PHPから書き込める場所を指定してください。
共用サーバーなどでは、Webから直接見ることのできない保存領域が用意されていることもあります。
公開領域の外に、PHPから書き込める保存先が使えるなら、その方が安心です。
例えば、お名前.comの共用サーバーSDの公式ヘルプでは、files フォルダはブラウザーから表示できない領域で、ログファイルなどの保存にも使えると案内されています。
ただし、実際の絶対パスやPHPから書き込めるかどうかは、使っている環境での確認が必要です。
ログを安全に保存する方法については、また別に少し詳しく見てみたいと思います。
例えばPHPを新しくしたあと
少し前に、僕はいくつかのWordPressサイトでPHPのバージョンを新しくしました。
PHPに重大な脆弱性|古いPHPを使っているWordPressで確認したいこと
PHPを新しくすると、
- 古いプラグイン
- 古いテーマ
- 自分で追加したPHPのコード
などが、新しいPHPではうまく動かないことがあります。
画面を見ただけでは、
「何かがおかしい」
ところまではわかっても、
どこで何が起きているのか
まではわからないことがあります。
そんなときに、
debug.log
を見ると、原因を探す手がかりになります。
使いっぱなしにはしない
ここは大切なところです。
WordPressのデバッグ機能は、
問題を調べるためのもの
です。
本番のサイトで、ずっと有効にしておくものではありません。
調査が終わったら、
define( 'WP_DEBUG', false );
に戻すなどして、デバッグを無効にしておきます。
無効にしても、すでに作られたログファイルは消えません。必要な確認が済んだログは、公開場所に残さないよう片づけておきましょう。
できることなら、公開されている本番サイトではなく、BASIC認証などで守られたテスト環境で確認できるとより安心ですね。
ログには、サイト内部の情報が記録されることもあります。
debug.log
を外から見られるような状態で置きっぱなしにしないことも大切です。
wp-config.phpのどこに書く?
デバッグの設定は、
/* That's all, stop editing! Happy publishing. */
などと書かれている行より前に書きます。
WordPressのバージョンや日本語化の状態によって、表示されている文言が少し違うこともあります。
大切なのは、
WordPressの設定を書く場所の中に追加する
ということですね。
すでに WP_DEBUG の設定がある場合には、同じ設定をもう一つ追加するのではなく、今あるものを確認して変更します。
まとめ
今回は、
WP_DEBUG_LOG
を使って、WordPressのエラーをログに残す方法を見てみました。
例えば、
define( 'WP_DEBUG', true );
define( 'WP_DEBUG_LOG', true );
define( 'WP_DEBUG_DISPLAY', false );
とすると、通常は、
wp-content/debug.log
にエラーや警告を残して確認できます。
なんだか動かない
↓
でも原因がわからない
↓
debug.logを見てみる
という一つの手がかりになるんですね。
ただし、デバッグは調査のために使うものです。
確認が終わったら、そのままにせず無効にしておきましょう。
ログの置き場所にも少し気をつけたいところです。
WordPressは、サイトごとにテーマやプラグイン、PHPのバージョンなどが違います。
同じWordPressでも設定を見比べてみると、
「こっちはこうなっていたんだ」
という発見があるかもしれません。
何をしていても、手がかりとなるログは超大事です。
エラーメッセージには、たくさんの手がかりが含まれています。
僕も、自分のサイトを見比べながら確認してみたいと思います。
読んでくださってありがとうございました。
それではまた!