【WordPress】フィルターフックの使い方・カスタマイズの例
WordPressでは、サイトをカスタマイズする方法の一つとして、フックを使用する方法があります。
フックを利用すると特定のタイミングで関数を実行するこができ、それによりサイトのカスタマイズを行えます。
そのフックには、フィルターフックとアクションフックの2種類がありますが、今回はフィルターフックの使い方・カスタマイズ例のまとめとなります。
また、アクションフックの使い方・カスタマイズ例のまとめは、以下のリンク先を参考にしてみてください。
フィルターフックを利用したカスタマイズについて
フィルターフックを使用したカスタマイズでは、指定したフックにカスタマイズを行う関数を登録します。
そうすると、WordPressがサイト構築する過程(「タイトル」や「本文」のデータを取得する前のタイミングなど)で、フックに登録した関数が実行されサイトのカスタマイズを行えます。
add_filter()|フィルターフックに関数を登録
指定したフィルターフックに関数を登録するには、add_filter()を使います。add_filter()のパラメータは以下となります。
パラメータ
add_filter( $tag, $function_to_add, $priority, $accepted_args );
$tag
関数を登録するフィルターフックの名前を指定。
$function_to_add
フィルターが適用されたときに呼び出される関数名(コールバック関数)を指定。
$priority(省略可)
フィルターフックに登録された関数が実行される順序を指定。数値が小さいほど先に実行し、同じ数値の場合は追加された順に実行する。初期値は10
$accepted_args(省略可)
フィルターフックに登録したコールバック関数が受け取る引数の個数を指定。初期値は 1
フィルターフックのカスタマイズ例
以下、当サイト内で紹介しているフィルターフックを使用したカスタマイズ例となります。
the_content|投稿本文
フィルターフックthe_contentを利用することで、投稿本文をカスタマイズできます。
使用例
document_title_parts|titleタグ
フィルターフックdocument_title_partsを利用することで、titleタグをカスタマイズできます。
使用例
tiny_mce_before_init|ビジュアルエディタ(TinyMCE)
フィルターフックtiny_mce_before_initを利用することで、ビジュアルエディタ(TinyMCE)の設定をカスタマイズできます。
使用例
wpseo_title|『Yoast SEO』使用時のtitleタグ
wpseo_titleは、プラグイン『Yoast SEO』独自のフィルターフック。wpseo_titleを利用することで、『Yoast SEO』使用時にtitleタグをカスタマイズできます。
使用例
その他のフィルターフックの例
このサイト内で紹介しているフィルターフックを使用したカスタマイズ例は他にもあります。詳しくは、以下のリンク先を参考にしてみてください。