説明
bool add_filter( string $tag, mixed $function_to_add [ , int $priority = 10 [ , int $accepted_args = 1 ] ] )
WordPressシステムの関数にフィルター関数を追加する。
パラメータ
- $tagWordPressシステムの関数名。
- $function_to_addフィルター関数名。メソッドを指定する場合は配列を使用する(注意を参照)。
- $priorityプライオリティ値(省略時は10)。
- $accepted_argsフィルター関数のパラメータ数(省略時は1)。
返り値
trueを返す。注意
クラスのメソッドを指定する場合は、オブジェクトのアドレスとメソッド名を要素にした配列を使用する。クラス内ならば、次のように記述する。add_filter( '関数名', array( $this, 'メソッド名' ) );
または
add_filter( '関数名', array( &$this, 'メソッド名' ) );
使用例
- ログインページのメッセージを変更するフィルター関数を追加する。<?php
?>add_filter( 'login_message', 'mylogin_message' ); function mylogin_message( $message ) { return '○○へようこそ'; }
- ログインページのメッセージを変更するフィルター関数を追加する(クラスの場合)。<?php
?>class myclass { function myclass( ) { add_filter( 'login_message', array( &$this, 'mylogin_message' ) ); } function mylogin_message( $message ) { return '○○へようこそ'; } }
最終更新 : 2022年11月08日 15:23
関連
お勧め
Login rebuilder 2.3.0の新機能を紹介(2018年5月27日 更新)
プラグイン「Login rebuilder」はログイン時の履歴(ログ)や不正なログインページへのアクセス履歴を保存している。これらの履歴情報はダッシュボートで確認できるが、バージョン2.3.0においてそれぞれがダウンロードできるようになった。
古めのリビジョンを削除した時のメモ(2022年5月16日 更新)
大きく育ったデータベースを整理するため、古めのリビジョンとそれに紐づいたカスタムフィールドデータを削除。と思ったら「The total number of locks exceeds the lock table size」というエラーが発生して削除できなかった。
決まった値を返すだけの関数群(2018年5月27日 更新)
WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。
「Align widgets horizontally」プラグインのフィルター使用例(2024年5月15日 更新)
ダッシュボードのウィジェットを横並びに変える「Align widgets horizontally」プラグインには緒設定を変更できるフィルターが用意されている。ここではフィルターの使い方と設定できる項目について紹介する。
WP_Postオブジェクトで投稿情報を直感的に使う(2012年10月4日 更新)
WordPress 3.5で登場するであろう WP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。