アクションフック・フィルターフック一覧

このページでは、WordPressテーマ「Arkhe(アルケー)」に用意されているアクションフック・フィルターフックを紹介していきます。

まだすごく雑な状態です、すみません…!

テンプレートパーツ読み込みに関するフック

Arkheでは、独自のメソッドでテンプレートパーツを読み込んでいます。

そのメソッドの中でも複数のフックが使えるようになっているのですが、この辺りに関しては別ページでまとめて解説しています。

アクションフック一覧

ヘッダー関連のアクションフック

'arkhe_before_header'

<header>に実行されるアクションフックです。

'arkhe_after_header'

</header>に実行されるアクションフックです。

'arkhe_header_bar_content'

ヘッダー上部で細かい情報を表示するためのフックです。
このフックを使用すると、以下のコンテンツが<header>内に出現します。

<div class="l-header__bar">
    <div class="l-header__barInner l-container">
        <!-- フックで出力するコンテンツ -->
    </div>
</div>
'arkhe_header_left_content'

ヘッダーロゴの左側に配置されるdiv.l-header__leftの内部で実行されるフックです。

'arkhe_header_right_content'

ヘッダーロゴの右側に配置されるdiv.l-header__rightの内部で実行されるフックです。

ドロワーメニュー関連のアクションフック

'arkhe_start_drawer_body'

ドロワーメニューのコンテンツ開始部分で実行されるフックです。
標準で表示されるドロワーメニュー内ナビよりも前にコンテンツを追加することができます。

'arkhe_after_drawer_nav'

ドロワーメニュー内ナビの直後ドロワーメニュー内ウィジェットの前で実行されるフックです。

'arkhe_end_drawer_body'

ドロワーメニューのコンテンツ終了部分で実行されるフックです。
「閉じる」ボタンよりは前に実行されます。

サイドバー関連のアクションフック

'arkhe_start_sidebar'

サイドバー開始タグ後で実行されるフックです。

'arkhe_end_sidebar'

サイドバーの閉じタグ前で実行されるフックです。

フッター関連のアクションフック

'arkhe_before_footer'

<footer>の前に実行されるフックです。

'arkhe_start_footer_inner'

div.l-footer__innerの開始部分で実行されるフックです。

'arkhe_start_footer_foot_content'

フッター下部コンテンツの開始部分(フッターナビの直前)で実行されるフックです。

'arkhe_before_copyright'

コピーライト直前で実行されるフックです。

'arkhe_after_copyright'

コピーライト直後で実行されるフックです。

'arkhe_after_footer'

</footer>の後に実行されるフックです。

コンテンツ

'arkhe_start_content'

div.l-contentの開始直後で実行されるフックです。

'arkhe_end_content'

div.l-contentの終了直前で実行されるフックです。

ページ種別ごとのアクションフック

フロント・ブログページ

ここでは、以下のような名称で各ページを呼ぶこととします。

  • フロントページis_front_page()trueのページ
  • フロント固定ページ:「ホームページ」に指定された固定ページ
    is_front_page()&is_page()trueのページ)
  • ブログページis_home()trueのページ
  • ブログ固定ページ:「投稿ページ」に指定された固定ページ
    is_home()trueかつ、is_front_page()falseのページ)
'arkhe_start_front_main'

フロントページ<main>後で実行されるフックです。

'arkhe_end_front_main'

フロントページ</main>前で実行されるフックです。

'arkhe_before_front_content'

フロント固定ページのコンテンツ前で実行されるフックです。

'arkhe_start_home_main'

ブログ固定ページ<main>後で実行されるフックです。

'arkhe_end_home_main'

ブログ固定ページ</main>前で実行されるフックです。

'arkhe_after_front_content'

フロント固定ページのコンテンツ後で実行されるフックです。

'arkhe_before_home_content'

ブログページのコンテンツ前で実行されるフックです。

'arkhe_after_home_content'

ブログページのコンテンツ後で実行されるフックです。

固定ページ

'arkhe_start_page_main' ( 引数 : $the_id )

固定ページ<main>後で実行されるフックです。

  • $the_id : ページID
'arkhe_end_page_main' ( 引数 : $the_id )

固定ページ</main>前で実行されるフックです。

'arkhe_before_page_content' ( 引数 : $the_id )

固定ページのコンテンツ前で実行されるフックです。

'arkhe_after_page_content' ( 引数 : $the_id )

固定ページのコンテンツ後で実行されるフックです。

投稿ページ

'arkhe_start_entry_main' ( 引数 : $the_id )

投稿ページ<main>後で実行されるフックです。

  • $the_id : ページID
'arkhe_end_entry_main' ( 引数 : $the_id )

投稿ページ</main>前で実行されるフックです。

'arkhe_before_entry_content' ( 引数 : $the_id )

投稿ページのコンテンツ前で実行されるフックです。

'arkhe_after_entry_content' ( 引数 : $the_id )

投稿ページのコンテンツ後で実行されるフックです。

'arkhe_start_entry_foot' ( 引数 : $the_id )

投稿ページの記事下、 .p-entry__footの開始直後で実行されるフックです。

'arkhe_end_entry_foot' ( 引数 : $the_id )

投稿ページの記事下、 .p-entry__footの終了直前で実行されるフックです。

アーカイブ

arkhe_start_archive_main
arkhe_end_archive_main
arkhe_before_term_post_list / $term_id
arkhe_before_archive_post_list

著者アーカイブ

arkhe_start_author_main / $author_id
arkhe_end_author_main / $author_id
arkhe_before_author_post_list / $author_id

検索結果ページ

arkhe_start_search_main
arkhe_end_search_main
arkhe_before_search_post_list

404ページ

arkhe_start_404_main
arkhe_end_404_main
arkhe_before_404_content
arkhe_after_404_content

その他

arkhe_after_author_name
arkhe_author_links

フィルターフック

ロゴ

arkhe_logo_tag / $tag
arkhe_head_logo_url / $logo_url
arkhe_head_logo_overlay_url / $logo_url

固定ページ

arkhe_page_subtitle / $subtitle, $the_id, $position

トップエリア

arkhe_ttlbg_img_id / $bgimg_id, $the_id
arkhe_top_area_excerpt / $excerpt, $the_id
arkhe_page_subtitle / $subtitle, $the_id, $position

投稿リスト

arkhe_list_type_on_home / $list_type
arkhe_list_type_on_term / $list_type, $term_id
arkhe_list_type_on_archive / $list_type, $archive_type
arkhe_list_type_on_author / $list_type, $author_id
arkhe_list_type_on_search / $list_type

arkhe_related_posts_args / $related_args
arkhe_related_area_title / $title
arkhe_author_area_title / $title

投稿ページ

arkhe_show_entry_thumb / $show, $id
arkhe_show_show_foot_terms / $show, $id
arkhe_show_show_prev_next_link / $show, $id
arkhe_show_author_box / $show, $id
arkhe_show_related_posts / $show, $id
arkhe_show_entry_comments / $show, $id

arkhe_get_the_term_links / $thelist, $post_id, $tax (‘cat’|’tag’)

検索結果ページ

arkhe_search_title

404ページ

arkhe_404_title
arkhe_404_content

その他

arkhe_content_width / $container_width

arkhe_gnav_location_name / $location_name (‘header_menu’)

arkhe_header_id / $header_id

arkhe_root_attrs / $attrs
arkhe_header_attrs / $attrs
arkhe_main_class / $class
arkhe_main_body_class / $class
arkhe_post_content_class / $class

arkhe_is_show_sidebar / $is_show_sidebar
arkhe_is_header_overlay / $is_header_overlay
arkhe_is_show_ttltop / $is_show_ttltop
arkhe_breadcrumbs_position / $breadcrumbs_pos

arkhe_breadcrumbs_data / $list_data

alignwideに関するフック

arkhe_alignwide_plus_width

「幅広」コンテンツ(.alignwide)を左右にどれだけ広げるかの数値。(単位はpxです。)
デフォルト値:80

arkhe_alignwide_pad_width

メディアクエリに指定する、「幅広」コンテンツを左右に拡大させるさせるブラウザサイズを調節するための数値。(単位はpxです。)
--ark-pad--containerと同じ数値に合わせることを推奨します。

デフォルト値:48