ワードプレスでデバッグログをダッシュボードに表示させる方法

2017-01-28 最終更新日:2017-01-28

ワードプレス運用中のサイトのエラーログを出力させてそれをダッシュボードで見る方法をご紹介します。

ログ出力方法は結構いろいろなサイトに書かれているのですがそれをダッシュボードに表示させる方法がなかったので作ってみました。WP_DEBUGを使ってデバッグモードをtrueにすれば表示させられるのですが、運用中のサイトにログが出力されてもいけないのでログファイルに保存するようにします。

まずはログファイルに出力させる方法は簡単です。

ログファイル出力設定

3ステップで完了できます。

1.wp-config.php設定

まずwp-config.phpに下記設定します。 WP_DEBUGがfalseになっているのをtrueに変更して、WP_DEBUG_LOGをtrueにします、これでログがとれます。それからWP_DEBUG_DISPLAYをfalseにします、これで画面出力を非表示にします。一応php側の設定でもdisplay_errorsも0にしてエラー出力を非表示にします。

wp-config.php

<?php;
define('WP_DEBUG', true);
define('WP_DEBUG_LOG', true);
define('WP_DEBUG_DISPLAY', false);
@ini_set('display_errors',0);

この設定だけでhttp://example.com/wp-content/debug.logなどのように、debug.logが出来ます。

ただこのままだとあからさまに見られてしまうので.htaccessに下記を追記します。

# BEGIN WordPressから# END WordPressまではワードプレスインストール時に出来ていると思いますのでその下のFiles debug.logから記述します。これでアクセスできないようにして見られなくします。

2.htaccess設定

.htaccess

# BEGIN WordPress
<IfModule mod_rewrite.c>
RewriteEngine On
RewriteBase /
RewriteRule ^index\.php$ - [L]
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule . /index.php [L]
</IfModule>
# END WordPress

<Files debug.log>
Order allow,deny
Deny from all
</Files>

これで外部アクセスから表示されません。

3.functions.php設定

最後にfunctions.phpに下記を記述します。これで完了です。

functions.php

<?php
// エラーログ取得
function getWpErrorLog() {
	// ファイルパス
	$logfile = WP_CONTENT_DIR.'/debug.log';
	// 最大ログ件数
	$maxlist = 10;
	// ログファイルかあるかどうか
	if ( file_exists( $logfile ) ) {
		$log = file($logfile);
		$reversed = array_reverse($log);
		echo '<ul class="wperrors">';
		$i = 0;
		foreach ($reversed as $reverse) {
			if ($i < $maxlist) {
				echo '<li>'.$reverse.'</li>';
			}
			$i++;
		}
		echo '</ul>';
	} else {
		echo '<p>ログを取得できません。</p>';
	}
}
// ダッシュボード表示
function WPErrorLogDashbordDisplay() {
	if (current_user_can('administrator')) {
		wp_add_dashboard_widget( 'wp-geterrors', 'デバッグエラーログ', 'getWpErrorLog' );
	}
}
add_action( 'wp_dashboard_setup', 'WPErrorLogDashbordDisplay' );

管理者権限のみと10件表示になっています。因みに時間がUTC時刻なので９時間ぐらいの差があります。日本時間にしたい場合は同じくfunctions.phpの先頭に下記を記述すると良いです。

<?php
date_default_timezone_set( 'Asia/Tokyo' );

参考になれば幸いです。

エンジニアのためのWordPress開発入門 (Engineer's Library)

posted with ヨメレバ

野島祐慈,菱川拓郎,杉田知至,細谷崇,枢木くっくる技術評論社 2017-01-26

Amazon

楽天ブックス

∞Tadashi Suyama∞

wordpress web functions