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

プラグインで注意が必要な関数 - 自作プラグインで「Call to undefined function」が発生したので調べてみた

説明

先日「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でどんな関数が定義されているかを整理したのが、次の表である。

関数名機能
wp_set_current_user現在のユーザ情報を設定する
wp_get_current_user現在のユーザ情報を取得する
get_currentuserinfo現在のユーザ情報を読み込む
get_userdataユーザIDを指定し、マッチするユーザ情報を取得する
get_user_byユーザ情報の一部を指定し、マッチするユーザ情報を取得する
cache_usersユーザ情報をキャッシュする
wp_mailメールを送信する
wp_authenticateユーザ名とパスワードでログインできるか調べる
wp_logoutログアウトする
wp_validate_auth_cookie認証クッキーが有効か調べる
wp_generate_auth_cookie認証クッキーを生成する
wp_parse_auth_cookie認証クッキーの情報を解析する
wp_set_auth_cookie認証クッキーを設定する
wp_clear_auth_cookie一連の認証クッキーをクリアする
is_user_logged_inログイン済みか調べる
auth_redirect未ログインならばログインページへリダイレクトする
check_admin_referer管理者ページのリファラーをチェックする
check_ajax_refererAJAXリクエストのリファラーをチェックする
wp_redirectリダイレクトする
wp_sanitize_redirectリダイレクトURLをサイタイズする
wp_safe_redirect安全なURLへリダイレクトする
wp_validate_redirectURLが安全か調べる
wp_notify_postauthorコメント/トラックバック/ピンバックの確認メールを送信する
wp_notify_moderatorコメント/トラックバック/ピンバックのモデレートメールを送信する
wp_password_change_notificationパスワード変更時の確認メールを送信する
wp_new_user_notificationユーザ追加時の確認メールを送信する
wp_nonce_tickナンスの元となる時間依存の値を取得する
wp_verify_nonceナンスの確認する
wp_create_nonceナンスを生成する
wp_saltソルトを取得する
wp_hashハッシュ値を取得する
wp_hash_passwordパスワードのハッシュ値を生成する
wp_check_passwordパスワードをチェックする
wp_generate_passwordパスワードを生成する
wp_rand乱数を取得する
wp_set_passwordパスワードを設定する
get_avatarアバターを取得する
wp_text_diffテキストを比較する

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 );
}

関連

お勧めコンテンツ

win_is_writable(2013年8月3日 登録)

bool win_is_writable( string $path )
Windows環境でディレクトリが書き込みできるか調べる。

is_singuler(2009年11月12日 登録)

bool is_singular( [ mixed $post_types = '' ] )
要求されているページが、投稿またはページか調べる。

map_deep(2015年12月12日 登録)

mixed map_deep( mixed $value, callback $callback )
変数内の要素についてコールバック関数を実行する。

has_post_format(2011年9月11日 登録)

bool has_post_format( string $format [ , mixed $post = null ] )
投稿に投稿フォーマットが設定されているか調べる。

wp_validate_boolean(2014年9月5日 登録)

bool wp_validate_boolean( mixed $var )
パラメータがブール値か評価する。

最終更新日時 : 2013-11-27 16:27