関数リファレンス/apply filters

説明

フィルターフックに追加された関数を呼び出します。フックの一覧は フィルターフック一覧 をご覧ください。

この関数により、フィルターフック $tag に付加されたコールバック関数が呼び出されます。この関数を、新しいフックの名前を $tag パラメータに指定して呼び出すことで、フィルターフックを新規作成することができます。

使い方

<?php apply_filters( $tag, $value, $var ... ); ?> 

パラメータ

$tag

（文字列） （必須） フィルターフック名。

初期値： なし

$value

（mixed） （必須） $tag に登録されたフィルター関数が変更できる値。

初期値： なし

$var

（mixed） （オプション） フィルター関数へ渡す追加の変数（複数指定可）。これは関数の中で使えるが値が返されることはない。バージョン 1.5.1 以降で利用可能。

初期値： なし

戻り値

(mixed) 

$value に全てのフィルター関数を適用した結果。

注: 戻り値の型は、$value の型（文字列や配列など）と同じでなければなりません。

用例

フィルター後にエコーする

echo apply_filters( $tag, $value );

フィルターを適用する

$myvar = apply_filters( $tag, $value );

追加フィルター変数を使う

$myvar = apply_filters( $tag, $value, $param, $otherparam );

例えば:

$myvar = apply_filters( 'example_filter', 'filter me', 'arg1', 'arg2 ');

the_title フィルターを使う

$my_custom_title = apply_filters( 'the_title', '  カスタムタイトル (tm)  ' );

上記の例では $my_custom_title に「カスタムタイトル ™」という文字列が含まれるようになります。the_title /en フィルターは、wptexturize() や trim() などを適用するからです。

変更履歴

• 新規導入: 0.71

ソースファイル

apply_filters() は wp-includes/plugin.php にあります。

関連項目

フィルター: has_filter(), add_filter(), apply_filters(), current_filter(), remove_filter(), remove_all_filters()

関数リファレンス、テンプレートタグ目次もご覧ください。

最新英語版： WordPress Codex » Function Reference/apply_filters （最新版との差分）