【WordPress】アクションフックの使い方・カスタマイズ例まとめ

WordPressでサイトをカスタマイズする方法の一つとして、特定のタイミングで関数を実行できる、フックを利用する方法があります。

そのフックには、アクションフックとフィルターフックの2種類がありますが、今回はアクションフックの使い方・カスタマイズ例のまとめとなります。

また、フィルターフックの使い方・カスタマイズ例のまとめは、以下のリンク先を参考にしてみてください。

アクションフックを利用したカスタマイズについて

アクションフックを使用したカスタマイズでは、指定したフックにカスタマイズを行う関数を登録します。

そうすると、特定のポイントやイベントのタイミング(「投稿の保存」「wp_head() 関数が呼び出された時」など)で、フックに登録した関数が実行されサイトのカスタマイズを行えます。

add_action()|アクションフックに関数を登録

指定したアクションフックに関数を登録するには、add_action()を使います。add_action()のパラメータは以下となります。

パラメータ

add_filter( $hook, $function_to_add, $priority, $accepted_args );

$hook

関数を登録するアクションフック名を指定。

$function_to_add

アクションフックが適用されたときに呼び出される関数名(コールバック関数)を指定。

$priority(省略可)

フィルターフックに登録された関数が実行される順序を指定。数値が小さいほど先に実行し、同じ数値の場合は追加された順に実行する。初期値は10

$accepted_args(省略可)

フィルターフックに登録したコールバック関数が受け取る引数の個数を指定。初期値は 1

アクションフックのカスタマイズ例

以下、当サイト内で紹介しているアクションフックを使用したカスタマイズ例となります。

wp_head

アクションフックwp_headに登録した関数は、wp_head() 関数を呼び出した際に実行します。

使用例

wp_footer

アクションフックwp_footerに登録した関数は、wp_footer() 関数を呼び出した際に実行します。

使用例

pre_get_posts

アクションフックpre_get_postsに登録した関数は、メインクエリによるデータベースへの問い合わせ前に実行します。

使用例

その他のアクションフックの例

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

サイト内を「アクションフック」で検索

参考サイトなど

コメント投稿コメント投稿欄を開く

コメントは項目欄(*は必須項目)を入力し、「コメントを送信」ボタンをクリックしてください。 (メールアドレスは公開されることはありません。コメントの公開は承認制となります。)

また、多忙によりコメントには返信できない場合があります。

Twitterで返信する場合はこちらから。