add_filter

(0.71以降)
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 '○○へようこそ';
        }
    }
    ?>

関連

  • add_action - アクション関数を追加する
  • balanceTags - タグの付け忘れを調整する
  • current_filter - 現在のフィルター(アクション)名を取得する
  • has_filter - WordPressタグにフィルターが登録されているか調べる
  • remove_filter - WordPressタグに登録されているフィルターを削除する

お勧めコンテンツ

ログアウト後はいつもサイトトップ(2015年5月7日 登録)

ログアウト後に表示(リダイレクト)されるページは、標準ではログインページ(wp-login.php)である。4.2.0ではログアウト処理後のページリダイレクト前に呼び出されるフィルターが追加された。

使っていないか確認しないとね!(2011年6月8日 登録)

2003年に誕生したWordPress。その歴史の中には、廃止予定(deprecated)となっている関数がいくつも存在する。それらの関数をテーマやプラグインで使用するべきではないし、使用しているなら代替の関数に書き換えるべきである。ここでは3.24.7.0現在、廃止予定となっている関数をまとめて紹介する。

プラグインのロード順を制御する(2014年6月9日 登録)

これまでプラグインがどのような順番でロードされるか意識していなかったのだが、とある自作プラグインを他のプラグインよりも先にロードさせたくなったので調べてみた。

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

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

Paste JSON text:プラグイン作ってみました(2012年1月19日 登録)

動作検証用のサーバーと本番サーバーで投稿データの同期作業(コピー&ペースト)を支援するプラグインです。動作検証用のサーバーで投稿記事をJSONテキストに変換してクリップボードにコピー。本番サーバーの新規投稿ページでクリップボードにコピーしたJSONテキストをペーストして、投稿記事のコピー&ペーストを実現します。複数サーバー間で投稿記事の同期を行っている方は、お試しあれ。

最終更新日時 : 2014-02-13 17:24