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

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

「テンプレートパーツ読み込み」に関するフックについて

Arkheでは、独自のメソッドでテンプレートパーツを読み込んでいます。
そのメソッドの中で複数のフックが通るようになっているのですが、この辺りに関しては少し複雑なので別ページでまとめて解説しています。

アクションフック一覧

では、ここからはArkheテーマ本体に設置されているアクションフックについて、紹介していきます。

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

フック名説明引数
'arkhe_before_header'<header>に実行されるアクションフックです。なし
'arkhe_after_header'</header>に実行されるアクションフックです。なし
'arkhe_header_bar_content'ヘッダー上部で細かい情報を表示するためのフックです。なし
'arkhe_header_left_content'ヘッダーロゴの左側に配置されるdiv.l-header__leftの内部で実行されます。なし
'arkhe_header_right_content'ヘッダーロゴの右側に配置されるdiv.l-header__rightの内部で実行されます。なし

'arkhe_header_bar_content'の補足

このフックを使用すると、以下のコンテンツが<header>内に出現します。

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

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

フック名説明引数
'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終了直前で実行されます。なし

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

フロント・ブログページ

フック名説明引数
'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'ブログページのコンテンツ後で実実行されます。なし

※ ここでは、各ページ種別を次のように表現しています。

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

固定ページ

フック名説明引数
'arkhe_start_page_main'固定ページの<main>で実行されます。$the_id
'arkhe_end_page_main'固定ページの</main>で実行されます。$the_id
'arkhe_before_page_content'固定ページのコンテンツ前で実行されます。$the_id
'arkhe_after_page_content'固定ページのコンテンツ後で実行されます。$the_id
引数の説明

$the_id : 現在表示中の固定ページID

投稿ページ

フック名説明引数
'arkhe_start_entry_main'投稿ページの<main>で実行されます。$the_id
'arkhe_end_entry_main'投稿ページの</main>で実行されます。$the_id
'arkhe_before_entry_content'投稿ページのコンテンツ前で実行されます。$the_id
'arkhe_after_entry_content'投稿ページのコンテンツ後で実行されます。$the_id
'arkhe_start_entry_foot'投稿ページの記事下、 .p-entry__footの開始直後で実行されます。$the_id
'arkhe_end_entry_foot'投稿ページの記事下、 .p-entry__footの終了直前で実行されます。$the_id
引数の説明

$the_id : 現在表示中の投稿ID

アーカイブ

フック名説明引数
'arkhe_start_archive_main'アーカイブページ (archive.php) の<main>で実行されます。なし
'arkhe_end_archive_main'アーカイブページ (archive.php) の</main>で実行されます。なし
'arkhe_before_term_post_list'タームアーカイブページ投稿リスト前で実行されます。$term_id
'arkhe_before_term_post_list'タームアーカイブ以外のアーカイブページ投稿リスト前で実行されます。なし
'arkhe_start_author_main'著者アーカイブページの<main>で実行されます。$author_id
'arkhe_end_author_main'著者アーカイブの</main>で実行されます。$author_id
'arkhe_before_author_post_list'著者アーカイブページの投稿リスト前で実行されます。$author_id
引数の説明
  • $term_id : 現在表示中のタームID
  • $author_id : 現在表示中のユーザーID

検索結果ページ

フック名説明引数
'arkhe_start_search_main'検索結果ページの<main>で実行されます。なし
'arkhe_end_search_main'検索結果ページの</main>で実行されます。なし
'arkhe_before_search_post_list'検索結果ページの投稿リスト前で実行されます。なし

404ページ

フック名説明引数
'arkhe_start_404_main'404ページの<main>で実行されます。なし
'arkhe_end_404_main'404ページの</main>で実行されます。なし
'arkhe_before_404_content'404ページのコンテンツ前で実行されます。なし
'arkhe_after_404_content'404ページのコンテンツ後で実行されます。なし

その他

フック名説明引数
'arkhe_after_author_name'記事の著者情報の名前下で実行されます。
※ Arkhe Toolkitから利用されます。
$author_id
'arkhe_author_links'記事の著者情報のサイトリンク下で実行されます。
※ Arkhe Toolkitから利用されます。
$author_id

フィルターフック

ここからはArkheテーマ本体に設置されているフィルターフックについて、紹介していきます。

関数用のフィルター

フック名説明引数
'ark_get__head_logo_img'ark_get__head_logo_img()の返り値を上書きできます。$return
$logo_id
'ark_the__thumbnail'ark_the__thumbnail()の出力を上書きできます。$return
$args
'ark_the__postdate'ark_the__postdate()の出力を上書きできます。$return
$date
$type
ark_the__pnlinkark_the__pnlink()の出力を上書きできます。$return
$args

「ヘッダー」用のフィルター

ヘッダーロゴ関連

フック名説明引数
'arkhe_logo_tag'ロゴ部分のHTMLタグを上書きできます。$tag
'arkhe_head_logo_url'ロゴのURLを上書きできます。
ver.1.5で廃止されました。
$url
'arkhe_head_logo_overlay_url'オーバーレイ時のロゴのURLを上書きできます。
ver.1.5で廃止されました。
$url
'arkge_head_logo_sizes'ロゴ画像のimgタグで出力されるsizes属性を指定できます。$sizes
'ark_get__head_logo_img'ark_get__head_logo_img()の返り値を上書きできます。$return
$logo_id

その他

フック名説明引数
'arkhe_gnav_location_name'グローバルナビとして呼び出すメニューのロケーション名を上書きできます。$location_name

「ページトップエリア」用のフィルター

「ページトップエリア」とは、Arkheテーマのデフォルトで固定ページのタイトルが出力されるエリアのことです。

フック名説明引数
'arkhe_ttlbg_img_id'エリア背景画像のIDを上書きできます。$img_id
$the_id
'arkhe_page_subtitle'ページのサブタイトルを上書きできます。$subtitle
$the_id
$position
'arkhe_top_area_excerpt'タイトル下に表示する抜粋文を上書きできます。$excerpt
$the_id
引数の説明
  • $the_id : ページのID
  • $img_id : エリア背景画像のID
  • $subtitle : サブタイトル
    • テーマ本体からサブタイトルは出力されず、デフォルトは空です。
  • $excerpt : 抜粋文
    • テーマ本体から抜粋文は出力されず、デフォルトは空です。

「投稿リスト」用のフィルター

フック名説明引数
'arkhe_list_type_on_home'ブログページに表示される投稿リストのレイアウトタイプを上書きできます。$list_type
'arkhe_list_type_on_term'タームアーカイブページに表示される投稿リストのレイアウトタイプを上書きできます。$list_type
$term_id
'arkhe_list_type_on_author'著者アーカイブページに表示される投稿リストのレイアウトタイプを上書きできます。$list_type
$author_id
'arkhe_list_type_on_archive'その他のアーカイブページに表示される投稿リストのレイアウトタイプを上書きできます。$list_type
$archive_type
'arkhe_list_type_on_search'検索結果ページに表示される投稿リストのレイアウトタイプを上書きできます。$list_type
引数の説明
  • $list_type : 投稿リストのレイアウトタイプ
  • $term_id : タームID
  • $author_id : ユーザーID
  • $archive_type : アーカイブ種別

「固定ページ」用のフィルター

フック名説明引数
'arkhe_page_subtitle'固定ページのサブタイトルを上書きできます。
※ Arkhe Toolkit で利用されます。
$subtitle
$the_id
$position
引数の説明
  • $subtitle : 現在のサブタイトル
    • テーマ本体からサブタイトルは出力されず、デフォルトは空です。
  • $the_id : 現在の固定ページID
  • $position : タイトルの表示位置 ( 'top' or 'inner' )

「投稿ページ」用のフィルター

投稿ページの各種コンテンツを「表示するかどうか」を上書きできるフック

フック名説明引数
'arkhe_list_type_on_home'投稿のアイキャッチ画像を表示するかどうかを上書きできます。$is_show
$the_id
'arkhe_show_show_foot_terms'投稿の下部に表示されるターム情報を表示するかどうかを上書きできます。$is_show
$the_id
'arkhe_show_show_prev_next_link'投稿の前の記事・次の記事へのリンクを表示するかどうかを上書きできます。$is_show
$the_id
'arkhe_show_author_box'投稿の著者情報を表示するかどうかを上書きできます。$is_show
$the_id
'arkhe_show_related_posts'投稿の関連記事を表示するかどうかを上書きできます。$is_show
$the_id
'arkhe_show_entry_comments'投稿のコメントを表示するかどうかを上書きできます。
→ v.1.6以降、'arkhe_is_show_comments'フックに変更されました。
$is_show
$the_id
引数の説明
  • $is_show : 表示するかどうかのbool値
  • $the_id : 現在表示中の投稿ID

投稿ページの各種コンテンツの内容を上書きできるフック

フック名説明引数
'arkhe_author_area_title'投稿の著者情報エリアのタイトルを上書きできます。$title
'arkhe_related_area_title'投稿の関連記事エリアのタイトルを上書きできます。$title
'arkhe_related_posts_args'投稿の関連記事を取得するためのクエリオプションを上書きできます。$query_args
'ark_get__thumbnail'投稿のアイキャッチ画像の出力を上書きできます。
v.1.5で廃止されました。
$output
$the_id
$thumb_args
'ark_get__term_links'投稿のタームリストの出力を上書きできます。
v.1.5で廃止されました。
$output
$the_id
$tax_slug
引数の説明
  • $title : 表示するタイトル
  • $query_args : クエリオプションの配列
  • $output : 出力内容
  • $the_id : 現在表示中の投稿ID
  • $tax_slug : タクソノミースラッグ。
    • テーマから渡されてくるのは'cat' or 'tag'のみ。

検索結果ページ

フック名説明引数
'arkhe_search_title'検索結果ページのタイトルを上書きできます。$title
$search_query
$cat_name
$tag_name
引数の説明
  • $title : タイトル
  • $search_query : 検索ワード
  • $cat_name : 検索されたカテゴリー名
    • $_GET['cat']がある時のみ、そのカテゴリー名が渡ってきます。
  • $tag_name : 検索されたタグ名
    • $_GET['tag']がある時のみ、そのタグ名が渡ってきます。

404ページ

フック名説明引数
'arkhe_404_title'404ページのタイトルを上書きできます。$title
'arkhe_404_content'404ページに表示するコンテンツを上書きできます。$content

その他

フック名説明引数
'arkhe_content_width'$GLOBALS['content_width']に渡す数値を上書きできます。$content_width
'arkhe_root_attrs'<html>タグに付与する属性値のリストを上書きできます。$attrs
'arkhe_header_attrs'<header>タグに付与する属性値のリストを上書きできます。$attrs
'arkhe_main_class'.l-mainに付与するクラス名を上書きできます。$class
'arkhe_main_body_class'.l-main__bodyに付与するクラス名を上書きできます。$class
'arkhe_post_content_class'.c-postContentに付与するクラス名を上書きできます。$class
'arkhe_is_show_sidebar'サイドバーを表示するかどうかを上書きできます。
※ デフォルトテンプレートにのみ有効です。
$is_show
'arkhe_is_show_ttltop'ページタイトルをコンテンツ上部に表示するかどうかを上書きできます。$is_show
'arkhe_is_header_overlay'ヘッダーオーバーレイを有効にするかどうかを上書きできます。$is_overlay
'arkhe_breadcrumbs_position'パンくずリストの位置を上書きできます。$position
'arkhe_breadcrumbs_data'パンくずリスト用のデータ配列を上書きできます。$data
'arkhe_is_show_comments'コメントエリアを表示するかどうかを上書きできます。$is_show
$the_id

「幅広」コンテンツに関するフック

「幅広」コンテンツ = .alignwideの付くコンテンツのことです。

フック名説明引数
'arkhe_alignwide_plus_width'「幅広」を左右にどれだけ広げるかの数値を上書きできます。※ 単位はpxになります$width
'arkhe_alignwide_pad_width'「幅広」を左右に拡大させるブラウザサイズの範囲をメディアクエリで指定するための数値。
※ 単位はpxになります。
※ CSSの--ark-pad--containerと同じ数値に合わせることを推奨します。
$content