フックなどで特定の値を返したい場合に役立つ関数

WordPressでは、フックを使ってカスタマイズすることがあります。 trueを返す関数、falseを返す関数など、特定の値を返す関数が用意されているので、これらを使うと便利なことがあります。

__return_●● 関数

WordPressでは、 wp-includes/functions.php に、特定の値を返す関数が、いくつか定義されています。

function __return_true() {
    return true;
}
function __return_false() {
    return false;
}
function __return_zero() {
    return 0;
}
function __return_empty_array() {
    return array();
}
function __return_null() {
    return null;
}
function __return_empty_string() {
    return '';
}

使い方の例

WordPress5.2 では、 wp-admin/includes/class-wp-screen.php で以下のように使われていました。

add_filter( 'screen_options_show_submit', '__return_true' );

この例のように、

add_filter( フィルターフック, '__return_***' );

と使うことが多いです。

クロージャは使わない

クロージャは、フックで実行する関数には使わない、というのがWordPressのルールになっています。

良くない例: (クロージャを使う代わりに、__return_●●を使いましょう。)

add_filter( フック, function() {
    return true;
} );