この記事は最後に更新してから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
関連
お勧め
single_tag_title（2018年5月27日 更新）
string single_tag_title( [ string $prefix = '' [ , bool $display = true ] ] )
投稿タグアーカイブページの投稿タグ名を取得し、パラメータ$displayがtrueならば表示する。$displayがfalseの場合は、文字列として返す。
current_time（2018年5月27日 更新）
mixed current_time( string $type [, mixed $gmt = 0 ] )
現在の日時を取得する。
get_attached_file（2015年4月28日 更新）
string get_attached_file( int $attachment_id [ , bool $unfiltered = false ] )
添付ファイルのパス名を取得する。
win_is_writable（2013年8月3日 更新）
bool win_is_writable( string $path )
Windows環境でディレクトリが書き込みできるか調べる。
is_tax（2014年12月23日 更新）
bool is_tax( [ mixed $taxonomy = '' [ , mixed $term = '' ] ] )
カテゴリーおよび投稿タグ以外のタクソノミーアーカイブページか調べる。