当サイト、Codex 日本語版は今後積極的な更新は行わない予定です。後継となる新ユーザーマニュアルは、https://ja.wordpress.org/support/ にあります。
万が一、当サイトで重大な問題を発見した際などは、フォーラムWordSlack #docs チャンネルでお知らせください。</p>

関数リファレンス/remove filter

提供: WordPress Codex 日本語版
< 関数リファレンス
2010年11月29日 (月) 11:36時点におけるMizuno (トーク | 投稿記録)による版 ({{原文|Function Reference/remove_filter|93356}}<!-- 00:15, 30 September 2010 Nkuttler 版 -->)

移動先: 案内検索

説明

この関数は、特定のフィルターフックに付加されている関数を除去します。特定のフィルターフックに付加されているデフォルト関数を除去することができ、別のものに置き換えできます。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 にあります。

関連資料

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



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


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