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 '○○へようこそ';
        }
    }
    ?>

最終更新 : 2020年04月02日 17:18



お勧め

ダッシュボードの「クイックドラフト」を「CodeMirror」に変更してみた(2019年11月5日 更新)

管理ページの「テーマエディター」では4.9以降「CodeMirror」が利用されている。今回はこの「CodeMirror」をプラグインで活用できないか調べた話である。

headタグのmeta(generator)タグを取り除く(2018年5月27日 更新)

標準的なWordPressのテーマで出力されるHTMLには、headタグ内に次のようなmetaタグが出力されている。
<meta name="generator" content="WordPress 3.0.5" />

Blacklist keys manager:プラグイン作ってみました(2015年5月22日 更新)

少し前から明らかにスパムと思われるコメントが投稿され、そのモデレーションメールを受け取る回数が増えてきた。あまりにもあからさまなコメントばかりなので、何らかの対策ができないか考えてみました。

5.5の機能強化:テーマ変更時に要求バージョンを確認(2020年8月12日 更新)

WordPress 5.5 RC 2が公開され、来週には正式版がリリース。変更箇所が多い「WordPress 5.5 RC 2(以降RC 2)」のソースコードを眺めていると、テーマの切り替え前にWordPressとPHPのバージョンを確認するようになっていた。

投稿内容に応じてwpautopを制御する(2013年8月13日 更新)

投稿内容を表示する the_content関数では、 wpautop関数がフィルターの1つとして呼び出され、改行をbrタグに変換したり、pタグで調整したりする。この機能自体は便利なのだが、きちんとデザインされたHTMLソースを流し込んだ場合はこの機能は好ましくない。そんなわけで、記事内容に応じてwpautop関数を制御できないか考えてみた。