この記事は最後に更新してから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
関連
お勧め
wp_add_post_tags（2012年7月5日 更新）
mixed wp_add_post_tags( [ int $post_id = 0 [ , string $tags = '' ] ] )
投稿情報に投稿タグを追加する。
get_tags（2018年5月27日 更新）
array get_tags( [ mixed $args = '' ] )
条件を指定してタグ情報を検索し、マッチしたすべてのタグ情報を取得する。
wp_array_slice_assoc（2022年2月2日 更新）
array wp_array_slice_assoc( array $array, array $keys )
キーを指定して配列の一部を抽出する。
get_post_permalink（2022年11月6日 更新）
string | false get_post_permalink( [ int | WP_Post $id$post = 0 [ , bool $leavename = false [ , bool $sample = false ] ] ] )
カスタム投稿タイプの投稿ページのパーマリンクを取得する。
remove_query_arg（2024年3月21日 更新）
string remove_query_arg( string | string[] $key [ , bool | string $query = false ] )
クエリーURIからパラメータ（キー名=値）を削除する。