この記事は最後に更新してから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_print_inline_script_tag（2021年4月19日 更新）
void wp_print_inline_script_tag( string $javascript [ , array $attributes = array() ] )
インラインJavaScriptを含むscript要素を出力する。
register_rest_route（2022年8月17日 更新）
bool register_rest_route( string $namespace, string $route [ , array $args = array() [ , bool $override = false ] ] )
REST APIのルートを登録する。
wp_determine_option_autoload_value（2024年7月22日 更新）
string wp_determine_option_autoload_value( string $option, mixed $value, mixed $serialized_value, boo l |string $autoload )
自動ロードのトリガー値を取得する。
single_tag_title（2018年5月27日 更新）
string single_tag_title( [ string $prefix = '' [ , bool $display = true ] ] )
投稿タグアーカイブページの投稿タグ名を取得し、パラメータ$displayがtrueならば表示する。$displayがfalseの場合は、文字列として返す。
home_url（2023年3月31日 更新）
string home_url( [ string $path = '' [ , string $scheme = null ] ] )
現在のブログ（サイト）のホームURLを取得する。ホームURLは、管理者ページの「設定」-「一般」の「サイトのアドレス(URL)」のこと。