- サイトデザイン工事中です。ご意見をお寄せください。
- 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。（詳細）
関数リファレンス/add filter
目次 |
説明
指定したフィルターフックに、関数をフックします。
フィルターは、様々な種類のテキストがデータベースまたはブラウザ画面に送信される前に WordPress が変更を行うフックです。プラグインは、フィルター API を利用して、指定したテキストをその時点で変更する PHP 関数を実行できます。フィルターフックの一覧は プラグイン_API/フィルターフック一覧 を参照してください。
使い方
<?php add_filter( $tag, $function_to_add, $priority, $accepted_args ); ?>
パラメータ
- $tag
- （文字列） （必須） $function_to_add がフックするフィルター名。
- 初期値： なし
- $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 にあります。
関連資料
フィルター: add_filter, has_filters, apply_filters, remove_filter, remove_all_filters, current_filter, merge_filters
最新英語版： WordPress Codex » Function_Reference/add_filter （最新版との差分）
テンプレート:Copyedit