関数リファレンス/remove filter

目次 1 説明 2 パラメータ 3 戻り値 4 用例 5 注 6 注 7 更新履歴 8 ソースファイル 9 関連資料

説明

この関数は、特定のフィルターフックに付加されている関数を除去します。特定のフィルターフックに付加されているデフォルト関数を除去することができ、別のものに置き換えできます。remove_action(), add_action() および add_filter() も参照してください。

重要: フックを除去するには、$function_to_remove と $priority 引数がフックが追加されたときと一致する必要があります。これはフィルター、アクションの双方に当てはまります。除去に失敗した時に警告は出ません。

パラメータ

$tag

（文字列） （必須） 除去する関数がフックしているアクションフック。

初期値： なし

$function_to_remove

（文字列） （必須） 除去する関数名。

初期値： なし

$priority

（整数） （オプション） (関数がフックされる時に定義される)関数の優先度。

初期値： 10

$accepted_args

（整数） （オプション） 関数が受け入れる引数の数。

初期値： 1

戻り値

(真偽値) 

関数が除去されたかどうか。

• True - 関数除去成功。
• False - 関数除去失敗。

用例

remove_filter( 'the_content', 'wpautop' );

foreach ( array( 'the_content', 'the_title', 'comment_text' ) as $hook )
    remove_filter( $hook, 'capital_P_dangit' );

注

オブジェクトが渡されるフィルターを使用しているとき、たいていは (オブジェクトの別インスタンスではなく) remove filter で完全に同一なオブジェクトを渡すことが必要でしょう。(詳細は _wp_filter_build_unique_id() 参照)

注

この関数は、意図したフィルター以外のフィルターも除去する可能性があります。

更新履歴

1.2.0 以降

ソースファイル

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

関連資料

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

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