プラグインで注意が必要な関数

説明

先日「Login rebuilder」という自作プラグインをアップデートした際、ユーザーさんからエラーになると連絡をいただいた。標準環境では問題なく、どうやら何らかのプラグインが影響しているらしい。

プラグインで発生したエラーの内容は「Call to undefined function wp_get_current_user」だった。より具体的には、プラグインのアップデートで拡張した wp_redirect関数のフィルター処理内で wp_get_current_user関数を呼び出すところで発生していた。wp_get_current_user関数は、どうやらプラグインの読み込み時には定義されていないということらしい。

wp-includes/pluggable.phpはプラグイン読み込みの後で

「WordPressの初期化の流れ」を再確認するとコアファイルであるpluggable.phpファイルの読み込みは、有効なプラグインファイルが読み込まれた後になっている。つまり、プラグインファイルの読み込み時は、pluggable.phpファイルで定義される関数は、準備されていないことになる。

pluggable.phpでどんな関数が定義されているかを整理したのが、次の表である。

pluggable.phpでは、認証に関連した多数の関数が定義されていることがわかる。そしてこれらは、プラグインによって事前に定義できるように設計されている。

今回のプラグインでエラーになった理由は、何らかのプラグインが読み込み時にwp_redirect関数を呼び出したことにより、こちらのプラグインが登録したフィルター関数が呼び出されてしまい、結果的にエラーとなったようだ。このことを踏まえると、プラグインではプラグインファイルの読み込み時に上記の関数を使用しないことはもちろんのこと、プラグインが登録するフィルターやアクション関数内で上記の関数の使用する場合に注意しなければならない。

この対策としては、次に示すように関数が定義されているか事前に確認するのが有効だろう。

if ( function_exists( 'wp_get_current_user' ) ) {
	// wp_get_current_user関数が定義されている場合
	$user = wp_get_current_user();
} else {
	// wp_get_current_user関数が未定義の場合
	$user = (object)array( 'data'=>null );
}