この記事は最後に更新してから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


お勧め

has_block(2018年12月13日 更新)

bool has_block( string $block_type [ , mixed $post = null ] )
投稿ブロックが含まれているか調べる。

get_home_url(2018年5月27日 更新)

string get_home_url( [ int $blog_id = null [ , string $path = '' [ , string $scheme = null ] ] ] )
任意のブログ(サイト)のホームURLを取得する。ホームURLは、管理者ページの「設定」-「一般」の「サイトのアドレス(URL)」のこと。

wp_auth_check(2024年2月19日 更新)

array wp_auth_check( array $response )
AJAXのheartbeatアクション用にユーザーがログイン中か調べる。

get_comment_author_url(2023年4月3日 更新)

string get_comment_author_url( [ int | WP_Comment $comment_id = 0 ] )
コメント投稿者のURLを取得する。

wp_set_password(2023年3月31日 更新)

void wp_set_password( string $password, int $user_id )
ログインパスワードを設定する。