WordPressのフィルタ・アクションでは、0, null, true, false, 空配列・空文字を返して無効化したり初期化したりします。
そのとき、自分で関数を作るより使うべき関数がありますよ、という話。
WordPressのカスタマイズはアクションとフィルター。
と言っていいほど、WordPressではアクションとフィルターに何かしらの処理(関数)を入れることが多いです。
(というか、それがすべて。そういう仕様。)
そんなとき、こんな関数を見たことあるでしょうか?
add_filter( 'override_load_textdomain', '__return_false' );
WordPressに実装された機能を無効化・初期化するときに使うやつですね?
サンプルで言えば、自分でfalseを返す関数を作らなくて済みます。1行で書けるし。
このようにWordPressには、アクション・フィルターに初期値を返す関数が用意されています。
__resutn_***()
ぜんぶこの形で、
関数 | 戻り値 | WPバージョン |
---|---|---|
__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以上 |
これらの関数はすべて wp-includes/functions.php にあります。
アクション・フィルターのパラメータ以外でも使っているのを見たことがありますが、WordPressオフィシャルでは想定していない使い方みたい。
自己責任。テーマやプラグインの公式アップの審査に引っかかるかも。
ちなみにボクは、アクション・フィルター以外では使ってません。