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

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

提供: WordPress Codex 日本語版
移動先: 案内検索
({{原文|Function_Reference/add_filter|84340}}<!-- 12:51, 17 March 2010 AdamBackstrom 版 -->)
 
(翻訳済み div 無)
1行目: 1行目:
== Description ==
+
== 説明 ==
  
Hooks a function to a specific filter action.
+
指定したフィルターフックに、関数をフックします。
  
Filters are the hooks that WordPress launches to modify text of various types  before adding it to the database or sending it to the browser screen. Plugins  can specify that one or more of its PHP functions is executed to  modify specific types of text at these times, using the Filter API.  See the [[Plugin_API/Filter_Reference]] for a list of filter hooks.
+
フィルターは、様々な種類のテキストがデータベースまたはブラウザ画面に送信される前に WordPress が変更を行うフックです。プラグインは、フィルター API を利用して、指定したテキストをその時点で変更する PHP 関数を実行できます。フィルターフックの一覧は [[プラグイン_API/フィルターフック一覧]] を参照してください。
  
== Usage ==
+
== 使い方 ==
  
%%% <?php add_filter( $tag, $function_to_add, $priority, $accepted_args ); ?> %%%
+
<code><?php add_filter( $tag, $function_to_add, $priority, $accepted_args ); ?> </code>
  
== Parameters ==
+
== パラメータ ==
  
{{Parameter|$tag|string|The name of the filter to hook the <tt>$function_to_add</tt> to.}}
+
{{Parameter|$tag|文字列|<tt>$function_to_add</tt> がフックするフィルター名。}}
{{Parameter|$function_to_add|callback|The name of the function to be called when the filter is [[Function Reference/apply_filters|applied]].}}
+
{{Parameter|$function_to_add|コールバック|フィルターが[[関数リファレンス/apply_filters|適用された]]/[[:en:Function Reference/apply_filters|en]] とき、呼び出される関数名。}}
{{Parameter|$priority|integer|Used to specify the order in which the functions associated with a particular action are executed. Lower numbers correspond with earlier execution, and functions with the same priority are executed in the order in which they were added to the action.|optional|10}}
+
{{Parameter|$priority|整数|特定のアクションを実行する関数の順序。数値が小さいほど早く実行し、同じ数値の場合は追加された順に実行する。|オプション|10}}
{{Parameter|$accepted_args|integer|The number of arguments the function(s) accept(s). In WordPress 1.5.1 and newer. hooked functions can take extra arguments that are set when  the matching do_action() or apply_filters() call is run.|optional|1}}
+
{{Parameter|$accepted_args|整数|関数が受け取る引数の数。WordPress 1.5.1 以降、対応する do_action() あるいは apply_filters() を実行するとき、フックした関数がさらに引数を取ることができる。|オプション|1}}
  
== Return ==  
+
== 戻り値 ==  
  
The function returns true whether the attempted function hook fails or not. There is no test that the function exists nor whether the <tt>$function_to_add</tt> is even a string. It is up to you to take care and this is done for optimization purposes, so everything is as quick as possible.
+
関数は、望み通りの関数フックの成否に関わらず true を返します。関数が存在するかどうか、あるいは <tt>$function_to_add</tt> が文字列かどうか、さえもテストしません。面倒を見るのはあなたです。これは最適化のためです。
  
== Example ==
+
== 用例 ==
  
== Notes ==
+
== ==
  
You may need to supply a pointer to the function's namespace for some filter callbacks, e.g.
+
フィルターコールバックに、名前空間を追加する必要があるかもしれません。
  
%%% <?php add_filter('media_upload_newtab', array(&$this, 'media_upload_mycallback')); ?> %%%
+
<code> <?php add_filter('media_upload_newtab', array(&$this, 'media_upload_mycallback')); ?> </code>
  
Otherwise WordPress looks in its own namespace for the function, which can cause abnormal behaviour.
+
さもないと WordPress は関数の名前空間を探し、異常なエラーを引き起こすかもしれません。
  
In WordPress 1.5.1+, hooked functions can take extra arguments that are set when the matching do_action() or apply_filters() call is run. For example, the action comment_id_not_found will pass any functions that hook onto it the ID of the requested comment.
+
WordPress 1.5.1+ では、フックした関数は、対応する do_action() あるいは apply_filters() を実行するとき、さらに引数を取ることができます。例えば、comment_id_not_found は、それにフックする任意の関数に、要求したコメントの ID を渡すことができます。
  
== Change Log ==
+
== 更新履歴 ==
  
 
Since: 0.71
 
Since: 0.71
  
== Source File ==
+
== ソースファイル ==
  
<tt>add_filter()</tt> is located in {{Trac|wp-includes/plugin.php}}.
+
<tt>add_filter()</tt> {{Trac|wp-includes/plugin.php}} にあります。
  
== Related ==
+
== 関連資料 ==
  
 
{{Filter Tags}}
 
{{Filter Tags}}

2010年3月28日 (日) 20:11時点における版

説明

指定したフィルターフックに、関数をフックします。

フィルターは、様々な種類のテキストがデータベースまたはブラウザ画面に送信される前に WordPress が変更を行うフックです。プラグインは、フィルター API を利用して、指定したテキストをその時点で変更する PHP 関数を実行できます。フィルターフックの一覧は プラグイン_API/フィルターフック一覧 を参照してください。

使い方

<?php add_filter( $tag, $function_to_add, $priority, $accepted_args ); ?>

パラメータ

$tag
文字列) (必須$function_to_add がフックするフィルター名。
初期値: なし
$function_to_add
コールバック) (必須) フィルターが適用された/en とき、呼び出される関数名。
初期値: なし
$priority
整数) (オプション) 特定のアクションを実行する関数の順序。数値が小さいほど早く実行し、同じ数値の場合は追加された順に実行する。
初期値: 10
$accepted_args
整数) (オプション) 関数が受け取る引数の数。WordPress 1.5.1 以降、対応する do_action() あるいは apply_filters() を実行するとき、フックした関数がさらに引数を取ることができる。
初期値: 1

戻り値

関数は、望み通りの関数フックの成否に関わらず true を返します。関数が存在するかどうか、あるいは $function_to_add が文字列かどうか、さえもテストしません。面倒を見るのはあなたです。これは最適化のためです。

用例

フィルターコールバックに、名前空間を追加する必要があるかもしれません。

<?php add_filter('media_upload_newtab', array(&$this, 'media_upload_mycallback')); ?>

さもないと WordPress は関数の名前空間を探し、異常なエラーを引き起こすかもしれません。

WordPress 1.5.1+ では、フックした関数は、対応する do_action() あるいは apply_filters() を実行するとき、さらに引数を取ることができます。例えば、comment_id_not_found は、それにフックする任意の関数に、要求したコメントの ID を渡すことができます。

更新履歴

Since: 0.71

ソースファイル

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

関連資料

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



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

最新英語版: WordPress Codex » Function_Reference/add_filter最新版との差分

この記事は翻訳時に編集が必要であるとマークされていました。その為Codex原文が大きく編集されている可能性があります。内容を確認される際は原文を参照していただき、可能であれば本項目へ反映させてください。よりよいCodexを作成するためのお手伝いをお願いします。