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

関数リファレンス/add filter

提供: WordPress Codex 日本語版
< 関数リファレンス
2010年3月28日 (日) 20:11時点におけるMizuno (トーク | 投稿記録)による版 (翻訳済み div 無)

移動先: 案内検索

説明

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

フィルターは、様々な種類のテキストがデータベースまたはブラウザ画面に送信される前に 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を作成するためのお手伝いをお願いします。