【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_title|投稿タイトル

フィルターフックthe_titleでは、投稿タイトルをカスタマイズできます。

使用例

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タグをカスタマイズできます。

使用例

その他のフィルターフックの例

このサイト内で紹介しているフィルターフックを使用したカスタマイズ例は他にもあります。詳しくは、以下のリンク先を参考にしてみてください。

サイト内を「フィルターフック」で検索

参考サイト、参考書籍

コメント投稿またはTwitterで返信

コメントは、以下の項目(*は必須項目)を入力し「コメントを送信」ボタンから送信お願いします。メールアドレスは公開されることはありません。
Twitterで返信する場合はコチラから。