この記事は最後に更新してから1年以上経過しています。

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

説明

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


お勧め

is_email(2017年11月28日 更新)

mixed is_email( string $email [, bool $deprecated = false ] )
文字列がメールアドレス形式か調べる。

get_option(2019年11月14日 更新)

mixed get_option( string $setting [ , mixed $default = false ] )
パラメータ$settingで指定されたオプションの値を取得する。

has_filter(2018年5月27日 更新)

mixed has_filter( $tag, [ mixed $function_to_check = false ] )
WordPressタグにフィルターが登録されているか調べる。

make_clickable(2012年4月26日 更新)

string make_clickable( $text )
テキスト中のURLをリンクに変換する。

get_bookmark(2011年6月10日 更新)

mixed get_bookmark( mixed $bookmark [ , string $output = OBJECT [ , string $filter = 'raw' ] ] )
リンク情報を取得する。