この記事は最後に更新してから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_specialchars_decode（2018年5月27日 更新）
string wp_specialchars_decode( string $string [ , mixed $quote_style = ENT_NOQUOTES ] )
HTMLエンティティ化された特殊文字をもとに戻す。
restore_previous_locale（2018年11月21日 更新）
string | bool restore_previous_locale()
直前のロケールへ戻す。
ent2ncr（2020年4月10日 更新）
string ent2ncr( string $text )
&のような名前エンティティを&のような数値エンティティに変換する。
wp_editor（2017年6月9日 更新）
void wp_editor( string $content, string $editor_id [ , array $settings = array( ] )
エディタを表示する。
get_post_types_by_support（2018年5月27日 更新）
array get_post_types_by_support( mixed $feature [ , string $operator = 'and' ] )
特徴（≒編集要素）の条件にマッチする投稿タイプ名を取得をする。