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

説明

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

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

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

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

add_filter( 'default_option_embed_autourls', '__return_true' );

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