Arkhe│最新版!アクションフック・フィルターフック119個全まとめ

WordPressテーマ「SWELL」と同じ制作者で作られたサイト制作に適したArkhe(アルケー)というテーマがあります。

たとえばWooCommerceを使ったECサイトを作る場合、SWELLではなくArkheが推奨されています。

そんなArkheでのサイト制作でよくフックを使うので、コードを調査してまとめてみました。

Arkheバージョン: 3.10.0で調査

目次

著者

WEB制作をしているデジタルノマド
WordPressのカスタマイズが好きで、色々と自作しています。

WordPressのカスタマイズに困ったらご相談ください!

Arkhe本体のアクションフック 55個まとめ

アクションフック(Action Hook)は、指定された場所やタイミングで処理を実行させるための仕組みです。

例えば、コンテンツが始まる前に特定の要素を追加したい場合、このフックを使うことで簡単に実現できます。

do_action( 'arkhe_xxxxxx' );

このリストではArkhe公式で抜け漏れているarkhe_end_footer_innerなどのフックの解説も載せています。

アクションフック名備考
arkhe_before_header<header>の前に実行されるフック
arkhe_after_header</header>の後に実行されるフック
arkhe_header_bar_contentヘッダー上部で情報を表示するためのフック
arkhe_header_left_contentヘッダー左側に配置されるコンテンツのフック
arkhe_header_right_contentヘッダー右側に配置されるコンテンツのフック
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フッター内のコンテンツ開始部分で実行されるフック
arkhe_end_footer_innerフッター内のコンテンツ終了部分で実行されるフック
※公式未記載
arkhe_start_footer_foot_contentフッター下部コンテンツの開始部分で実行されるフック
arkhe_before_copyrightコピーライトの前に実行されるフック
arkhe_after_copyrightコピーライトの後に実行されるフック
arkhe_after_footer</footer>の後に実行されるフック
arkhe_start_contentコンテンツ部分の開始時に実行されるフック
arkhe_end_contentコンテンツ部分の終了時に実行されるフック
arkhe_start_front_mainフロントページのメイン部分の開始時に実行されるフック
arkhe_end_front_mainフロントページのメイン部分の終了時に実行されるフック
arkhe_before_front_contentフロントページのコンテンツ前に実行されるフック
arkhe_start_home_mainホームページのメイン部分の開始時に実行されるフック
arkhe_end_home_mainホームページのメイン部分の終了時に実行されるフック
arkhe_after_front_contentフロントページのコンテンツ後に実行されるフック
arkhe_before_home_contentホームページのコンテンツ前に実行されるフック
arkhe_after_home_contentホームページのコンテンツ後に実行されるフック
arkhe_start_page_main固定ページのメイン部分の開始時に実行されるフック
arkhe_end_page_main固定ページのメイン部分の終了時に実行されるフック
arkhe_before_page_content固定ページのコンテンツ前に実行されるフック
arkhe_after_page_content固定ページのコンテンツ後に実行されるフック
arkhe_start_entry_main投稿ページのメイン部分の開始時に実行されるフック
arkhe_end_entry_main投稿ページのメイン部分の終了時に実行されるフック
arkhe_before_entry_content投稿ページのコンテンツ前に実行されるフック
arkhe_after_entry_content投稿ページのコンテンツ後に実行されるフック
arkhe_start_entry_foot投稿ページのフッター部分の開始時に実行されるフック
arkhe_end_entry_foot投稿ページのフッター部分の終了時に実行されるフック
arkhe_start_archive_mainアーカイブページのメイン部分の開始時に実行されるフック
arkhe_end_archive_mainアーカイブページのメイン部分の終了時に実行されるフック
arkhe_before_term_post_listタームアーカイブページの投稿リスト前に実行されるフック
arkhe_before_archive_post_listアーカイブページの投稿リスト前に実行されるフック
arkhe_start_author_main著者アーカイブページのメイン部分の開始時に実行されるフック
arkhe_end_author_main著者アーカイブページのメイン部分の終了時に実行されるフック
arkhe_before_author_post_list著者アーカイブページの投稿リスト前に実行されるフック
arkhe_start_search_main検索結果ページのメイン部分の開始時に実行されるフック
arkhe_end_search_main検索結果ページのメイン部分の終了時に実行されるフック
arkhe_before_search_post_list検索結果ページの投稿リスト前に実行されるフック
arkhe_start_404_main404ページのメイン部分の開始時に実行されるフック
arkhe_end_404_main404ページのメイン部分の終了時に実行されるフック
arkhe_before_404_content404ページのコンテンツ前に実行されるフック
arkhe_after_404_content404ページのコンテンツ後に実行されるフック
arkhe_after_author_name著者情報の名前の後に実行されるフック
arkhe_author_links著者情報のリンクの後に実行されるフック
arkhe_pre_get_part__{$slug}パーツ取得前に実行されるフック
※公式未記載
arkhe_did_get_part__{$slug}パーツ取得後に実行されるフック
※公式未記載
Arkhe本体のアクションフック一覧

Arkhe本体のアクションフック 55個の解説とサンプルコード

arkhe_before_header

arkhe_before_headerは、Arkheテーマにおいて、ヘッダー部分が表示される前に実行されるアクションフックです

このフックを利用することで、ヘッダーの直前に特定の要素や機能を追加することができます。

add_action( 'arkhe_start_content', 'add_custom_content_start_message' );
function add_custom_content_start_message() {
    echo '<div class="custom-message">コンテンツがここから始まります</div>';
}

arkhe_after_header

arkhe_after_headerは、Arkheテーマにおいて、ヘッダー部分が表示された直後に実行されるアクションフックです

このフックを使うことで、ヘッダーの直後に特定の要素やカスタマイズを追加することができます。

// ヘッダーの後にカスタムバナーを表示
add_action( 'arkhe_after_header', 'add_custom_after_header_banner' );
function add_custom_after_header_banner() {
    echo '<div class="custom-banner">限定セール開催中!今すぐチェック</div>';
}

arkhe_header_bar_content

arkhe_header_bar_contentは、Arkheテーマでヘッダーバーの内容をカスタマイズするためのアクションフックです

このフックを使うことで、テーマのヘッダーバー内に自由にコンテンツを追加することができます。

// ヘッダーバーにカスタムメッセージを追加
add_action( 'arkhe_header_bar_content', 'add_custom_header_bar_content' );
function add_custom_header_bar_content() {
    echo '<p class="header-bar-message">特別なプロモーション中!詳しくはこちら</p>';
}

arkhe_header_left_content

arkhe_header_left_contentは、Arkheテーマのヘッダー部分の左側にコンテンツを追加またはカスタマイズするためのアクションフックです。

このフックを使うことで、ロゴの左側に任意のコンテンツを表示したり、カスタマイズすることが可能です。

// ヘッダー左側にカスタムメッセージを追加
add_action( 'arkhe_header_left_content', 'add_custom_header_left_content' );
function add_custom_header_left_content() {
    echo '<div class="custom-header-left">特別なお知らせはこちら!</div>';
}

arkhe_header_right_content

arkhe_header_right_contentは、Arkheテーマのヘッダー部分の右側にコンテンツを追加またはカスタマイズするためのアクションフックです。

このフックを使うことで、ヘッダーの右側にSNSアイコン、カートアイコン、ログインリンクなど、任意のコンテンツを追加することができます。

// ヘッダー右側にソーシャルメディアリンクを追加
add_action( 'arkhe_header_right_content', 'add_custom_header_right_content' );
function add_custom_header_right_content() {
    echo '<div class="header-social-links">';
    echo '<a href="https://twitter.com" target="_blank">Twitter</a> | ';
    echo '<a href="https://facebook.com" target="_blank">Facebook</a>';
    echo '</div>';
}

arkhe_start_drawer_body

arkhe_start_drawer_bodyは、Arkheテーマのドロワーメニューのボディ部分が開始される直前に実行されるアクションフックです。

このフックを使うことで、ドロワーメニューの開始部分にカスタムコンテンツや要素を追加することが可能です。

// ドロワーメニューの開始部分にカスタムメッセージを追加
add_action( 'arkhe_start_drawer_body', 'add_custom_drawer_body_message' );
function add_custom_drawer_body_message() {
    echo '<div class="drawer-custom-message">特別セール開催中!今すぐチェック</div>';
}

arkhe_after_drawer_nav

このフックは、ドロワーメニューのナビゲーションが終わった後に特定のコンテンツを挿入するために使用されます

例えば、ナビゲーションの下に追加の情報やプロモーションバナー、ソーシャルメディアリンクなどを表示したい場合に利用できます。

// ドロワーメニューのナビゲーション後にソーシャルメディアリンクを追加
add_action( 'arkhe_after_drawer_nav', 'add_custom_after_drawer_nav_content' );
function add_custom_after_drawer_nav_content() {
    echo '<div class="drawer-social-links">';
    echo '<a href="https://twitter.com" target="_blank">Twitter</a> | ';
    echo '<a href="https://facebook.com" target="_blank">Facebook</a>';
    echo '</div>';
}

arkhe_end_drawer_body

arkhe_end_drawer_bodyは、Arkheテーマにおいて、ドロワーメニューのボディ部分が終了する直前に実行されるアクションフックです。

このフックを利用することで、ドロワーメニューの末尾にカスタムコンテンツを追加することができます。

// ドロワーメニューの終了部分にカスタムボタンを追加
add_action( 'arkhe_end_drawer_body', 'add_custom_end_drawer_button' );
function add_custom_end_drawer_button() {
    echo '<div class="drawer-custom-button">';
    echo '<a href="https://example.com" class="button">お問い合わせ</a>';
    echo '</div>';
}

arkhe_start_sidebar

arkhe_start_sidebarは、Arkheテーマにおいて、サイドバーが表示される前に実行されるアクションフックです。このフックを使うことで、サイドバーの上部にカスタムコンテンツを追加することが可能です。

例えば、サイドバーの最初に特別なお知らせやバナーを表示することができます。

// サイドバーの開始部分にカスタムメッセージを追加
add_action( 'arkhe_start_sidebar', 'add_custom_start_sidebar_message' );
function add_custom_start_sidebar_message() {
    echo '<div class="sidebar-custom-message">特別なお知らせ:今だけ無料!</div>';
}

arkhe_end_sidebar

arkhe_end_sidebarは、Arkheテーマにおいて、サイドバーの内容がすべて表示された後に実行されるアクションフックです。

このフックを使うことで、サイドバーの最後に追加のコンテンツや要素を挿入することが可能です。

たとえば、サイドバーの末尾にカスタムバナーやSNSリンク、特定のアクションボタンを表示したい場合に便利です。

// サイドバーの終了部分にソーシャルメディアリンクを追加
add_action( 'arkhe_end_sidebar', 'add_custom_end_sidebar_content' );
function add_custom_end_sidebar_content() {
    echo '<div class="sidebar-social-links">';
    echo '<a href="https://twitter.com" target="_blank">Twitter</a> | ';
    echo '<a href="https://facebook.com" target="_blank">Facebook</a>';
    echo '</div>';
}

arkhe_pre_get_part__{$slug}

arkhe_pre_get_part__{$slug}は、Arkheテーマでテンプレートパーツを読み込む前に発火するアクションフックです。

このフックを使用することで、特定のテンプレートパーツが読み込まれる直前に任意の処理を実行することができます。

{$slug}は、読み込まれるテンプレートパーツの識別子で、特定のパーツに応じてフックをカスタマイズすることができます。

// テンプレートパーツ「header」が読み込まれる前にカスタムメッセージを表示
add_action( 'arkhe_pre_get_part__header', 'before_header_part_message' );
function before_header_part_message() {
    echo '<p class="custom-message">ヘッダーが表示される前のカスタムメッセージ</p>';
}

arkhe_did_get_part__{$slug}

arkhe_did_get_part__{$slug}は、Arkheテーマにおいて、指定されたテンプレートパーツが読み込まれた後に発火するアクションフックです。

このフックを使用することで、特定のテンプレートパーツが表示された後に追加の処理を実行することが可能です。

{$slug}は読み込まれるテンプレートパーツの識別子です。

// ヘッダーが読み込まれた後にカスタムメッセージを表示
add_action( 'arkhe_did_get_part__header', 'after_header_part_message' );
function after_header_part_message() {
    echo '<p class="custom-message">ヘッダーの読み込みが完了しました。</p>';
}

以下、制作予定

Arkhe本体のフィルタフック 64個まとめ

フィルターフック(Filter Hook)は、関数を使ってデータを操作する際に使います。

例えば、表示されるテキストを変更したり、データを加工することができます。

apply_filters( 'arkhe_xxxxxx', $return );

フィルタフック名備考
ark_get__head_logo_imgヘッダーロゴ画像の取得結果を上書き
ark_the__thumbnail投稿のサムネイル画像の出力を上書き
ark_the__postdate投稿の日付表示を上書き
ark_the__pnlink前後の記事リンクを上書き
arkhe_logo_tagロゴ部分のHTMLタグを上書き
arkhe_head_logo_urlヘッダーロゴのURLを上書き
arkhe_head_logo_overlay_urlオーバーレイロゴのURLを上書き
arkhe_head_logo_sizesヘッダーロゴの画像サイズ属性を上書き
arkhe_gnav_location_nameグローバルナビのメニュー位置を上書き
arkhe_ttlbg_img_idタイトル背景画像のIDを上書き
arkhe_page_subtitleページのサブタイトルを上書き
arkhe_top_area_excerptタイトル下の抜粋文を上書き
arkhe_list_type_on_homeホームページの投稿リストのレイアウトを上書き
arkhe_list_type_on_termタームアーカイブページの投稿リストのレイアウトを上書き
arkhe_list_type_on_author著者アーカイブページの投稿リストのレイアウトを上書き
arkhe_list_type_on_archiveアーカイブページの投稿リストのレイアウトを上書き
arkhe_list_type_on_search検索結果ページの投稿リストのレイアウトを上書き
arkhe_show_entry_thumb投稿のアイキャッチ画像を表示するかを上書き
arkhe_show_foot_terms投稿のターム情報の表示を上書き
arkhe_show_prev_next_link前後の記事リンクの表示を上書き
arkhe_show_author_box投稿の著者情報を表示するかを上書き
arkhe_show_related_posts関連記事の表示を上書き
arkhe_show_entry_comments投稿のコメントエリアの表示を上書き
arkhe_author_area_title著者情報エリアのタイトルを上書き
arkhe_related_area_title関連記事エリアのタイトルを上書き
arkhe_related_posts_args関連記事取得のクエリを上書き
ark_get__thumbnail投稿のサムネイル取得結果を上書き
ark_get__term_links投稿のタームリンクリストの出力を上書き
arkhe_search_title検索結果ページのタイトルを上書き
arkhe_404_title404ページのタイトルを上書き
arkhe_404_content404ページのコンテンツを上書き
arkhe_content_widthコンテンツの幅を上書き
arkhe_root_attrs<html>タグの属性を上書き
arkhe_header_attrs<header>タグの属性を上書き
arkhe_main_class.l-mainクラスの名前を上書き
arkhe_main_body_class.l-main__bodyクラスの名前を上書き
arkhe_post_content_class.c-postContentクラスの名前を上書き
arkhe_is_show_sidebarサイドバーの表示を上書き
arkhe_is_show_ttltopタイトルトップの表示を上書き
arkhe_is_header_overlayヘッダーオーバーレイの有無を上書き
arkhe_breadcrumbs_positionパンくずリストの位置を上書き
arkhe_breadcrumbs_dataパンくずリストのデータを上書き
arkhe_is_show_commentsコメントエリアの表示を上書き
arkhe_alignwide_plus_width幅広コンテンツの広がりを上書き
arkhe_move_post_count_into_a投稿数カウントの位置を上書き
※以下、公式未記載
ark_the__taglineサイトのタグラインを上書き
arkhe_customizer_argsカスタマイザーの引数を上書き
arkhe_list_layouts投稿リストのレイアウトを上書き
arkhe_get_the_terms_dataタームデータの取得を上書き
arkhe_get_author_icon_data著者アイコンデータを上書き
arkhe_get_archive_dataアーカイブデータの取得を上書き
arkhe_get_tax_of_post_type投稿タイプのタクソノミー取得を上書き
arkhe_part_args__{$slug}パーツの引数を上書き
arkhe_part_path__{$slug}パーツのパスを上書き
arkhe_part_cache__{$slug}パーツのキャッシュデータを上書き
arkhe_part__{$slug}パーツの内容を上書き
arkhe_main_body_attrsメインボディの属性を上書き
arkhe_use_fse_blocksFSEブロックの使用を上書き
arkhe_get_svgSVGアイコンの取得を上書き
arkhe_use_lazy_top_areaトップエリアの遅延読み込みを上書き
arkhe_term_descriptionタームの説明文を上書き
arkhe_show_term_descriptionタームの説明文の表示を上書き
Arkhe本体のフィルターフック一覧

Arkhe本体のフィルターフック 64個の解説とサンプルコード

以下、制作予定

Arkhe Blocksのフック 6個の解説とサンプルコード

Arkhe Blocks のフックもまとめてみました。

バージョン 2.23.0

アクションフック

無し

フィルターフック

フック名簡単な説明
arkb_blogcard__cache_timeブログカードのキャッシュ時間を変更するためのフィルター
arkb_blogcard__title_lengthブログカードのタイトルの長さを変更するためのフィルター
arkb_blogcard__excerpt_lengthブログカードの抜粋文の長さを変更するためのフィルター
arkb_blogcard__name_lengthブログカードの名前の長さを変更するためのフィルター
arkb_section__media_htmlセクションブロックのメディアHTMLを変更するためのフィルター
arkb_toc__ignore_classes目次(ToC)の無視するクラスを指定するためのフィルター

Arkhe Blocks Proのフック 11個の解説とサンプルコード

Arkhe Blocks Proのフックもまとめてみました。

バージョン 2.26.0

アクションフック

無し

フィルターフック

フィルターフック名備考
arkb_rss__cache_timeRSSフィードのキャッシュ時間を変更するためのフィルター
arkb_slider__arrow_svgスライダーの矢印アイコン(SVG)を変更するためのフィルター
arkb_blogcard__cache_timeブログカードのキャッシュ時間を変更するためのフィルター
arkb_blogcard__title_lengthブログカードのタイトルの長さを変更するためのフィルター
arkb_blogcard__excerpt_lengthブログカードの抜粋文の長さを変更するためのフィルター
arkb_blogcard__name_lengthブログカードの名前の長さを変更するためのフィルター
arkb_section__media_htmlセクションブロックのメディアHTMLを変更するためのフィルター
arkb_slide__media_htmlスライドブロックのメディアHTMLを変更するためのフィルター
arkb_toc__ignore_classes目次(ToC)の無視するクラスを指定するためのフィルター
arkb_boxlink__figure_htmlボックスリンクの画像部分のHTMLを変更するためのフィルター
arkb_boxlink__svgボックスリンク内のSVGアイコンを変更するためのフィルター

Arkhe Toolkitのフック 13個の解説とサンプルコード

Arkhe Toolkitのフックもまとめてみました。

バージョン 1.11.1 

アクションフック

アクションフック名備考
arkhe_toolkit_before_share_btns_listシェアボタンリストの表示前に実行されるアクションフック

フィルターフック

フィルターフック名備考
arkhe_toolkit_twitter_to_xTwitterのリンクをX(旧Twitter)に変更するためのフィルター
arkhe_toolkit_delay_js_prevent_pagesJS遅延を防止するページを指定するためのフィルター
arkhe_toolkit_delay_js_listJS遅延対象のリストを変更するためのフィルター
arkhe_toolkit_side_meta_screensサイドメタボックスを表示する画面を指定するためのフィルター
arkhe_toolkit_code_meta_screensコードメタボックスを表示する画面を指定するためのフィルター
arkhe_toolkit_hide_share_btnsシェアボタンの非表示設定をカスタマイズするためのフィルター
arkhe_toolkit_term_meta_screensタームメタボックスを表示する画面を指定するためのフィルター
arkhe_toolkit_use_fix_sidebar固定サイドバーを使用するかどうかを指定するフィルター
arkhe_toolkit_json_ldJSON-LDデータをカスタマイズするためのフィルター
arkhe_toolkit_json_ld_article記事のJSON-LDデータを変更するためのフィルター
arkhe_toolkit_get_share_btns_listシェアボタンのリストをカスタマイズするためのフィルター
arkhe_toolkit_get_svgSVGアイコンの取得結果を変更するためのフィルター
  • URLをコピーしました!
目次