この記事は最後に更新してから1年以上経過しています。
説明
WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。
決まった値を返すだけの関数はWordPressバージョン3.0.0で登場し、現在では次に示す表のようになっています。
| 関数名 | 返り値 | バージョン |
|---|---|---|
| __return_true | true | 3.0.0 |
| __return_false | false | 3.0.0 |
| __return_zero | 0 | 3.0.0 |
| __return_empty_array | array() | 3.0.0 |
| __return_null | null | 3.4.0 |
| __return_empty_string | '' | 3.7.0 |
これらはフィルター向けの関数として使用されるほか、コールバック関数としても利用されています。
使い方はシンプルで、これらの関数名をフィルター追加時に指定するだけ。一部では関数名の後のプライオリティ値を指定するケースもあるようです。
add_filter( 'default_option_embed_autourls', '__return_true' );関数名の先頭にある'_'は2つなので、タイプミスしないように注意したいところです。
最終更新 : 2018年05月27日 10:45
関連
お勧め
get_next_post（2018年5月27日 更新）
object get_next_post( [ bool $in_same_cat$in_same_term = false [ , string $excluded_categoriesmixed $excluded_terms = '' [ , string $taxonomy = 'category' ] ] ] )
1つ後の投稿情報を取得する。
wp_loginout（2018年5月27日 更新）
void wp_loginout( [ string $redirect = '' ] )
閲覧者がログインしているかどうかを調べ、ログインしていなければログインページのリンクを、ログイン済みならばログアウトページのリンクを表示する。
get_terms（2020年12月14日 更新）
array get_terms( mixed $args = array(), mixed $deprecated = '' mixed $taxonomies, [ mixed $args = '' ] )
条件を指定してタクソノミー情報を検索し、マッチしたすべてのデータを取得する。
wp_localize_script（2018年5月27日 更新）
bool wp_localize_script( string $handle, string $object_name, array $l10n )
スクリプト向けの変数を追加する。
get_post_status_object（2014年10月9日 更新）
object get_post_status_object( string $post_status )
投稿ステータス情報を取得する。