関数リファレンス/apply filters

目次 1 説明 2 使い方 3 パラメータ 4 戻り値 5 用例 5.1 フィルター後にエコーする 5.2 フィルターされる 6 注 7 更新履歴 8 ソースファイル 9 関連資料

説明

フィルターフックに追加された関数を呼び出します。フィルターフックの一覧は プラグイン_API をごらんください。

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

使い方

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

パラメータ

$tag

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

初期値： なし

$value

（mixed） （必須） フィルターがフックされている $tag が変更できる値。

初期値： なし

戻り値

(mixed) 

全てのフックされた関数が適用された後の $value の結果。

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

用例

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

echo apply_filters( $tag, $value );

フィルターされる

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

注

更新履歴

• 0.71 以降

ソースファイル

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

関連資料

フィルター: add_filter, has_filters, apply_filters, remove_filter, remove_all_filters, current_filter, merge_filters

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