add_filter

説明

bool add_filter( string $tag, mixed $function_to_add [ , int $priority = 10 [ , int $accepted_args = 1 ] ] )
WordPressシステムの関数にフィルター関数を追加する。

パラメータ

  • $tag
    WordPressシステムの関数名。
  • $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 '○○へようこそ';
        }
    }
    ?>

最終更新 : 2018年05月27日 10:50



お勧め

4.4では投稿ページも専用テンプレートが適用できる(2018年5月27日 更新)

従来、特定の固定ページには専用テンプレートを適用できるのですが、投稿ページに適用させるためにはアクションやフィルターを利用する必要がありました。4.4では特定の投稿ページに標準で専用テンプレートを適用できるようになりそうです。

プラグインで注意が必要な関数(2013年11月27日 更新)

先日「Login rebuilder」という自作プラグインをアップデートした際、ユーザーさんからエラーになると連絡をいただいた。標準環境では問題なく、どうやら何らかのプラグインが影響しているらしい。

タイトルのみをキーワード検索する(2014年4月3日 更新)

WordPressのキーワード検索は、投稿タイトルと本文のどちらかに指定したキーワードが含まれているかを調べるわけだが、時々タイトルだけとか、逆に本文だけ検索したいケースがある。

oEmbedについて考えてみた(2018年5月27日 更新)

本サイト向けにテーマをリニューアルしようと思い一から作っている最中、ふと生成されているHTMLの中にあるoEmbedの記述が目についた。「この記述いつからだっけ」くらいに思いながらリンク先を開き、ちょっとモヤモヤしてしまった。

一定時間でログアウトする(2013年5月23日 更新)

ログイン関係を調べている関係で、 wp_set_auth_cookie関数に行き着く。ログイン画面の「ログイン状態を保持する」がチェックされた場合、クッキーの有効期限は14日間。チェックされていない場合は、ブラウザが閉じるまで常に有効となっているんだね。