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

「関数リファレンス/remove filter」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
({{原文|Function Reference/remove_filter|85217}}<!-- 15:17, 2 April 2010 Ramiy 版 -->)
 
(翻訳済み、div は付けていない)
1行目: 1行目:
{{NeedTrans}}
+
== 説明 ==
== Description ==
+
この関数は、特定のフィルターフックに付加されている関数を除去します。特定のフィルターフックに付加されているデフォルト関数を除去することができ、別のものに置き換えできます。[[関数リファレンス/remove filter|remove_action()]], [[関数リファレンス/add action|add_action()]] および [[関数リファレンス/add filter|add_filter()]] も参照してください。
  
This function removes a function attached to a specified filter hook. This method can be used to remove default functions attached to a specific filter hook and possibly replace them with a substitute. See also [[Function Reference/remove action|remove_action()]], [[Function Reference/add filter|add_filter()]] and [[Function Reference/add action|add_action()]].
+
'''''重要:''''' 長い間バグが修正されず現在の実装になっているため、この関数を呼び出すときにどのフィルターを除去するか予測できません。使用すると、意図しないフィルターを失うかもしれません。プラグイン作成者は、可能ならこの関数の使用を避けてください。
  
'''''Important:''''' Because of long-time unfixed bugs resulting in flaws of the underlying implementation, it is unpredictable which filters this function will remove when called. Usage might/will result in loss of other then the intended filter(s). Plugin authors should prevent the usage of this function if possible.
 
  
'''''Important:''' To remove a hook, the <tt>$function_to_remove</tt> and <tt>$priority</tt> arguments must match when the hook was added. This goes for both filters and actions. No warning will be given on removal failure.''
+
'''''重要:''' フックを除去するには、<tt>$function_to_remove</tt> <tt>$priority</tt> 引数がフックが追加されたときと一致する必要があります。これはフィルター、アクションの双方に当てはまります。除去に失敗した時に警告は出ません。''
  
== Parameters ==
+
== パラメータ ==
  
{{Parameter|$tag|string|The action hook to which the function to be removed is hooked.}}
+
{{Parameter|$tag|文字列|除去する関数がフックしているアクションフック。}}
{{Parameter|$function_to_remove|string|The name of the function which should be removed.}}
+
{{Parameter|$function_to_remove|文字列|除去する関数名。}}
{{Parameter|$priority|int|The priority of the function (as defined when the function was originally hooked).|optional|10}}
+
{{Parameter|$priority|整数|(関数がフックされる時に定義される)関数の優先度。|オプション|10}}
{{Parameter|$accepted_args|int|The number of arguments the function accepts.|optional|1}}
+
{{Parameter|$accepted_args|整数|関数が受け入れる引数の数。|オプション|1}}
  
== Return ==
+
== 戻り値 ==
  
; (''boolean'') : Whether the function is removed.
+
; (''真偽値'') : 関数が除去されたかどうか。
:* <tt>True</tt> - The function was successfully removed.
+
:* <tt>True</tt> - 関数除去成功。
:* <tt>False</tt> - The function could not be removed.
+
:* <tt>False</tt> - 関数除去失敗。
  
== Example ==
+
== 用例 ==
  
== Notes ==
+
== ==
This function might remove more then the specified filter(s).
+
この関数は、意図したフィルター以外のフィルターも除去する可能性があります。
  
== Change Log ==
+
== 更新履歴 ==
  
* Since: 1.2.0
+
1.2.0 以降
  
== Source File ==
+
== ソースファイル ==
  
<tt>remove_filter()</tt> is located in {{Trac|wp-includes/plugin.php}}.
+
<tt>remove_filter()</tt> {{Trac|wp-includes/plugin.php}} にあります。
  
 
{{原文|Function Reference/remove_filter|85217}}<!-- 15:17, 2 April 2010 Ramiy 版 -->
 
{{原文|Function Reference/remove_filter|85217}}<!-- 15:17, 2 April 2010 Ramiy 版 -->
  
== Related ==
+
== 関連資料 ==
  
 
{{Filter Tags}}
 
{{Filter Tags}}

2010年4月16日 (金) 08:33時点における版

説明

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

重要: 長い間バグが修正されず現在の実装になっているため、この関数を呼び出すときにどのフィルターを除去するか予測できません。使用すると、意図しないフィルターを失うかもしれません。プラグイン作成者は、可能ならこの関数の使用を避けてください。


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

パラメータ

$tag
文字列) (必須) 除去する関数がフックしているアクションフック。
初期値: なし
$function_to_remove
文字列) (必須) 除去する関数名。
初期値: なし
$priority
整数) (オプション) (関数がフックされる時に定義される)関数の優先度。
初期値: 10
$accepted_args
整数) (オプション) 関数が受け入れる引数の数。
初期値: 1

戻り値

(真偽値
関数が除去されたかどうか。
  • True - 関数除去成功。
  • False - 関数除去失敗。

用例

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

更新履歴

1.2.0 以降

ソースファイル

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

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

関連資料

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



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