関数リファレンス/is wp error

説明

渡された変数が WordPress Error であるかチェックします。

その変数が PHP オブジェクトであり、かつ WP_Error クラスによって生成されたものであるか判定します。

使い方

<?php is_wp_error( $thing ); ?>

パラメータ

$thing

（mixed） （必須） 任意の存在する変数。既知のタイプでも不明なタイプでも構わない。

初期値： なし

戻り値

(真偽値) 

WP_Error なら true を、異なれば false を返す。

用例

if ( is_wp_error( $result ) ) {
   $error_string = $result->get_error_message();
   echo '<div id="message" class="error"><p>' . $error_string . '</p></div>';
}

参考

• WP_Error クラスの使い方について詳しくは クラスリファレンス/WP_Error を見てください。

変更履歴

2.1.0 : 新規導入。

ソースファイル

is_wp_error() は wp-includes/load.php にあります。

関連項目

関数リファレンス、テンプレートタグ目次もご覧ください。

最新英語版： WordPress Codex » Function Reference/is_wp_error （最新版との差分）