【開発やカスタマイズに】wordpressでデバッグする方法

最終更新日

debug

wordpressでデバッグする方法

今回はwordpressデバッグを行う方法について紹介していきます。

webサービスの開発や、システムの開発では必ずといってもデバッグは必要です。webサイトにおいてもJavaScriptで、アニメーションやちょっとした動きをつけたりする際にもよく使われます。

 

デバッグ方法は、プログラミングの言語によっても異なるので、もし wordpressでのデバッグの方法をまだ知らない方は、ぜひこの記事を読んで参考にして頂ければと思います。

 

それでは、見ていきましょう。

 

デバッグとは

まずは簡単にデバッグとは、についてご紹介します。恐らくこの記事を読まれている方は、ご存知の方が多いと思いますが、一応まだ知らないという方のたまに簡単に解説しておきます。

 

デバッグdebug)とは、簡単にいうと、エラーの場所を簡単に見つける方法です。

例えば、JavaScriptを使って、”自動でスクロールをしたい”という時、そのアクションを作動させるためのコードのみを書いた場合、何かしらの問題で(誤字、脱字など)エラーが起きた場合、”自動でスクロール”というアクションが動かない状況になります。

そして、なぜその問題が起きたのか、どのコードが原因でエラーが起きたのか、などはよくわからない状態のままになります。

そこで、起きた問題やエラーをより詳しく知るために行うのが、デバッグです。

 

ここでデバッグすることによって、どのコードが正しく作動しているか、あるいはどのコードがうまく作動していないのか、問題があるか、などを把握する事ができます。

 

ここまで書けば、デバッグの必要性について、ご理解頂けたのではないでしょうか。

webの開発などにおいては、デバッグなしでは基本的に進める事ができません。ぜひ必要な方は、この記事を参考にしてもらえたらと思います。

 

  

wordpressでデバッグするには、デバッグモードを使う

それではwordpressで、デバッグする方法について書いていきます。

wordpressは、デバッグの方法が、JavaScriptなどの他の言語のデバッグより、やや分かりづらく、方法も若干手間がかかりますが見ていきましょう。

 

wp-config.phpを編集する

まずは、wordpress の構成ファイルの一つ、wp-config.phpを編集します。

サーバーのFTPで、このファイルを見ると、この様な記述を発見できます。


define('WP_DEBUG', false);

通常は、デフォルトではこの様な記述になっており、falseの部分を、trueと変更するとデバッグモードがオンになります。


define('WP_DEBUG', true);

 

ロリポップでインストールしたwordpressのwp-config.phpには、この様に詳しく日本語で説明まで表記されていました。

/**
 * 開発者へ: WordPress デバッグモード
 *
 * この値を true にすると、開発中に注意 (notice) を表示します。
 * テーマおよびプラグインの開発者には、その開発環境においてこの WP_DEBUG を使用することを強く推奨します。
 *
 * その他のデバッグに利用できる定数については Codex をご覧ください。
 *
 * @link http://wpdocs.osdn.jp/WordPress%E3%81%A7%E3%81%AE%E3%83%87%E3%83%90%E3%83%83%E3%82%B0
 */
define('WP_DEBUG', false);

この様に書いといてもらえると、かなり分かりやすいですね。

 

デバッグモードを使うとブラウザ上にエラーが表示される様になる

上の方法で、デバッグモードをオンにすると、ブラウザ上にエラーが表示されます。

サイトの画面上に、この様な、テキストが表示される様になります。

実際に何が書いてあるか、notice:注意、error:エラー、ファイルの場所、ファイル内のどのコードが問題か(line)が書かれています。

 

これを目印に、ファイルを修正していきます。

基本的に問題がなければこの様な表示が出てくることはありませんが、noticeが出てもサイトの動作には全く影響がない場合もあります。

 

とはいえ開発の際には、このデバッグモードをオンにして、機能の開発や修正を行うと、よりエラーを簡単に発見する事ができ、時間の短縮につながります。

  

デバッグモードはオン 画面上には表示させない方法

上に書いた方法でデバッグの方法については、お分かり頂けたと思います。

上の方法では、サイトの開発中であれば、全く問題はありませんが、すでに運営しているwebサービスなどの機能の修正などの場合、エラーが発生してもエラーのテキストを画面に表示させたくない場合もあると思います。

 

そこで必要なのが、エラー内容を画面に出力するのではなく、ファイルに出力する様に変更する方法です。

define('WP_DEBUG_LOG', true);
define('WP_DEBUG_DISPLAY', false);
@ini_set('display_errors',0);

という記述を追加します。

デバッグモードをオンにする記述と組み合わせると、この様になります。

define('WP_DEBUG', true);
if ( WP_DEBUG ) {
	define('WP_DEBUG_LOG', true);
	define('WP_DEBUG_DISPLAY', false);
	@ini_set('display_errors',0);
}

なんとなくコード読んで、意味が伝わるかと思いますが、

ファイルにデバッグログを出力し、画面上のデバッグをなしに、という内容になります。

運用中のサイトの改修などを行う際には、少し手間になりますがこちらの方法が良いですね。

 

まとめ

今回は、wordpressでのデバッグの方法について紹介しました。

簡単で分かりやすくデバッグできるJavaScriptなどと違い、ファイルから書き換えが必要なwordpressのデバッグは少し手間がかかり、分かりにくさもありますが、開発などを行う際にはデバッグする事で効率が上がります。

  

ぜひwordpressで開発を行う際は、この記事を参考にデバッグする方法を試してもらえればと思います。

sasurai

旅と写真を愛する人。 web制作の仕事をしています。 写真も撮ります。お仕事のお問い合わせはお気軽に。

シェアする