• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

関数リファレンス/has filter

提供: WordPress Codex 日本語版
移動先: 案内検索

この項目「関数リファレンス/has filter」は、翻訳チェック待ちの項目です。加筆、訂正などを通して、Codex ドキュメンテーションにご協力下さい。

指定したフックにフィルター(関数)が登録されているか確認します。

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

使い方

<?php has_filter( $tag, $function_to_check ); ?>

パラメータ

$tag
文字列) (必須) フィルターフックの名前。
初期値: なし
$function_to_check
コールバック関数) (オプション) 指定すると、フック内でのその関数の優先順位を返します。指定した関数がこのフックに登録されていなければ false を返します。
初期値: false – 指定なし

戻り値

整数 | 真偽値 
関数を指定しない場合、フックに何か関数が登録されていれば true を、一つも登録されていなければ false を返します。関数を指定すると(第 2 パラメータ)、関数が登録されていればフック内での優先順位を整数で、登録されていなければ false を返します。

用例

フィルターフック 'the_content' に関数 'prefix_alter_the_content' が登録されていなければ、それを登録します。

<?php
if ( ! has_filter( 'the_content', 'prefix_alter_the_content' ) )
	add_filter( 'the_content', 'prefix_alter_the_content' );
?>

参考

  • グローバルな配列 $wp_filter を使用します。すべてのフィルターフックが保存されています。

変更履歴

  • 新規導入: 2.5.0

ソースファイル

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

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


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


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