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

関数リファレンス/add filter

提供: WordPress Codex 日本語版
< 関数リファレンス
2010年3月28日 (日) 19:50時点におけるMizuno (トーク | 投稿記録)による版 ({{原文|Function_Reference/add_filter|84340}}<!-- 12:51, 17 March 2010 AdamBackstrom 版 -->)

(差分) ← 古い版 | 最新版 (差分) | 新しい版 → (差分)
移動先: 案内検索

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.

Usage

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

Parameters

$tag
string) (必須) The name of the filter to hook the $function_to_add to.
初期値: なし
$function_to_add
callback) (必須) The name of the function to be called when the filter is applied.
初期値: なし
$priority
integer) (optional) 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.
初期値: 10
$accepted_args
integer) (optional) 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.
初期値: 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 $function_to_add 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.

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')); ?> %%%

Otherwise WordPress looks in its own namespace for the function, which can cause abnormal behaviour.

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.

Change Log

Since: 0.71

Source File

add_filter() is located in wp-includes/plugin.php.

Related

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



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

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

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