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タグに登録されているフィルターを削除する

お勧めコンテンツ

囲み型ショートコードとwpautop(2014年10月22日 登録)

ショートコードは投稿記事の閲覧時に動的に内容を変更できる優れもの。galleryやcaptionなどいくつかのショートコードが標準で組み込まれており、一部のプラグインではその機能を利用する手段としてショートコードが利用されている。

スクリプトファイルのバージョンパラメータを変更する(2015年2月10日 登録)

Java Scriptやスタイルシートの指定を直接head要素内に記述せず、wp_enqueue_scriptsフィルターなどを使って指定する場合、WordPressのバージョン番号が付与されている。このバージョン番号は、妥当なんだろうか。

投稿記事でrubyタグを使えるようにする(前編)(2012年1月25日 登録)

rubyなどのルビ関連タグはIEの独自サポートから始まり、少し前のChrome/Safariが追随して利用できるようになっている。Firefoxはいまだにサポートしていないのだが、それなりに代替表示されるので、投稿記事で使えるようにしてみた。

Login rebuilderに「XML-RPC設定」を追加しました(2015年12月31日 登録)

公式サイトで公開しているプラグイン「Login rebuilder」をバージョンアップし、XML-RPCリクエストの管理機能を追加しました。Login rebuilderの主たる機能は、ログインページをサイト別にユニークなURLに変更し、ログインページへの不正アクセスを回避することです。WordPressのXML-RPCリクエストはピンバックや外部ツールやサイトなどとの連携に利用されていますが、今回追加した機能ではXML-RPCリクエストの処理に対していくつかの制限できるようにしています。

HTML編集モードに定型文ボタンを追加する(2011年6月1日 登録)

投稿編集ページにはビジュアル編集モードとHTML編集モードがあり、それらを拡張するプラグインも多数存在している。そういったプラグインを利用するのもいいのだが、仕組みを理解するのも悪くないはず。というわけで、ここではHTML編集モードのボタンの仕組みと定型文を挿入するボタンを追加する方法を紹介する。

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