本記事では、WordPressで変数に代入されている値がWordPress Errorか判定する方法について解説しています。
WordPressの学習におすすめ参考書
1冊ですべて身につくWordPress入門講座
【中・上級者向け】オリジナルテーマの作り方が学べるおすすめ参考書
WordPressオリジナルテーマ制作入門
is_wp_error関数の使い方
WordPressで変数に代入されている値がWordPress Errorであるか判定するには、is_wp_error関数を使用します。基本的な使い方は以下のとおりです。
<?php is_wp_error( $thing ); ?>
- $thing(必須):WordPress Errorであるか判定したい変数を指定。
is_wp_error関数の真偽値(true/false)の値を返します。
引数に渡した変数がWP_ERRORオブジェクトならtrueを返し、それ以外ならfalseを返します。
実際に、is_wp_error関数を使用してWordPress Errorであるか判定するサンプルコードを用意したので動作確認してみましょう。
サンプルコードでは、get_the_terms関数を使用しています。この関数は記事に紐づいているターム情報を返しますが、無効なタクソノミーを指定するとWP_ERRORオブジェクトを返します。
<?php $terms = get_the_terms(get_the_ID(), 'test-category') ?>
<?php if (is_wp_error($terms)) : ?>
<?php echo 'WP_ERRORオブジェクトが返されました。'; ?>
<?php endif; ?>
上記のサンプルコードでは、get_the_terms関数の第二引数に対して無効なタクソノミーを指定していると想定します。そのため、get_the_terms関数は戻り値としてWP_ERRORオブジェクトを変数$termsに返します。
結果、if文の条件に一致し「WP_ERRORオブジェクトが返されました。」の文字がブラウザに表示されます。