WordPress でフィルターを作成および追加するための関連する PHP 関数の詳細な説明

apply_filters() (フィルターの作成)
apply_filters() 関数は、フィルターを作成するために使用されます。これは、WordPress プラグインのメカニズムで非常に重要な関数であり、他のテーマやプラグインでの使用を可能にします。値に一致する変更フィルタリングを実行します。

Usage

apply_filters( $tag, $value, $var... );

Parameters

$tag

(文字列) (必須) フィルターの名前。

デフォルト値: なし

$value

(混合) (必須) フィルターされる値。誰もフィルターしない場合、この値が直接返されます。

$var

(混合) (オプション) 追加の変数パラメーターをフィルター関数に渡し、フィルター関数が戻り値を操作できるようにします。無制限の数値を追加できます。

戻り値

(混合) フィルタリングされた値。誰もフィルタリングしない場合、$value の値が直接返されます。

例

誰もフィルタリングしていません:

echo apply_filters( 'test', '可以被修改的值' );

印刷結果:

変更可能な値

誰かがフィルタリングしています:

function test_func(){
  return '修改值';
}
add_filter( 'test', 'test_func' );
echo apply_filters( 'test', '可以被修改的值' );

印刷結果:

変更された値

受信パラメータ:

function test_func(){
  return '修改值';
}
add_filter( 'test', 'test_func' );
function test_func2( $text ){
  return $text . '2';
}
add_filter( 'test', 'test_func2' );
echo apply_filters( 'test', '可以被修改的值' );

複数のパラメータ:

function test_func( $text, $var, $var2 ){
  return '修改值' . $var1 . $var2;
}
add_action( 'test', 'test_func', 10, 3 );
echo apply_filters( 'test', '可以被修改的值', '辅助值1', '辅助值2' );

その他

この関数は、wp-includes/plugin.php にあります

add_filter() (フィルターの追加)
add_filter() は、指定されたフィルターに関数をマウントできます。

Usage

add_filter( $tag, $function_to_add, $priority, $accepted_args );

Parameters

$tag

(文字列) (必須) マウントされたフィルターの名前 (ターゲットの apply_filters() 関数の $tag 属性と同じ)。

デフォルト値: なし

$function_to_add

(callback) (必須) 実装するコールバック関数については、PHP コールバック関数の種類のドキュメントを参照してください。

デフォルト値: なし

$priority

(整数) (オプション) 実行順序。関数が小さいほど、最初に実行されます。

デフォルト値: 10

$accepted_args

(整数) (オプション) コールバック関数で受け取るパラメーターの数を複数設定すると、apply_filters() 関数で渡されるパラメーターをさらに受け取ることができます。

デフォルト値: 1

戻り値

(ブール値)は常にTrueです

例

function test_func( $text, $var1, $var2 ){
  return $text . $var1 . $var2;
}
add_action( 'test', 'test_func', 10, 3 );
echo apply_filters( 'test', '参数2', '参数3', '参数4' );

Print:

testparameter2parameter3

other

この関数はwp-includes/pluginにあります。

上記では、WordPress でフィルターを作成および追加するための関連する PHP 関数を、関連コンテンツも含めて詳しく紹介しました。PHP チュートリアルに興味のある友人に役立つことを願っています。