決まった値を返すだけの関数群

説明

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。

決まった値を返すだけの関数はWordPressバージョン3.0.0で登場し、現在では次に示す表のようになっています。

関数名返り値バージョン
__return_truetrue3.0.0
__return_falsefalse3.0.0
__return_zero03.0.0
__return_empty_arrayarray()3.0.0
__return_nullnull3.4.0
__return_empty_string''3.7.0

これらはフィルター向けの関数として使用されるほか、コールバック関数としても利用されています。

使い方はシンプルで、これらの関数名をフィルター追加時に指定するだけ。一部では関数名の後のプライオリティ値を指定するケースもあるようです。

add_filter( 'default_option_embed_autourls', '__return_true' );

関数名の先頭にある'_'は2つなので、タイプミスしないように注意したいところです。


最終更新 : 2018年05月27日 10:45


お勧め

get_post_format_strings(2011年9月12日 更新)

string get_post_format_strings( )
投稿フォーマット名の一覧を取得する。

get_allowed_mime_types(2012年12月20日 更新)

array get_allowed_mime_types( )
有効なMIMEタイプを取得する。

get_category_parents(2018年5月27日 更新)

mixed get_category_parents( int $id [ , bool $link = false [ , string $separator = '/' [ , bool $nicename = false [ , array $deprecated $visited = array() ] ] ] ] )
親カテゴリー名を含んだカテゴリー名を取得する。

wp_remote_post(2017年5月23日 更新)

mixed wp_remote_post( string $url [ , array $args = array() ] )
POSTメソッドを送信する。

set_url_scheme(2018年5月27日 更新)

string set_url_scheme( string $url, string $scheme = null )
URLに適正なスキーマをセットする。