この記事は最後に更新してから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
関連
お勧め
add_magic_quotes（2020年8月13日 更新）
array add_magic_quotes( array $array )
配列の文字列をスラッシュでクォートする。
wp_parse_id_list（2019年2月23日 更新）
array wp_parse_id_list( array | string $list )
IDのリストをパースする。
wp_mkdir_p（2014年11月27日 更新）
bool wp_mkdir_p( string $target )
ディレクトリを再帰的に作成する。
get_object_taxonomies（2018年5月27日 更新）
array get_object_taxonomies( mixed $object [ , string $output = 'names' ] )
投稿タイプのタクソノミー情報を取得する。
add_media_page（2022年6月27日 更新）
mixed add_media_page( string $page_title, string $menu_title, mixed string $capability, string $menu_slug [ , mixed $function = '' [, int $position = null ] ] )
メディアメニューにサブメニューを登録する。