Vendix Theme は各表示箇所をプラグインや子テーマに開放しています。このリファレンスでは、文書化されたフックを一覧で紹介します。各フックの詳細は、テーマの readme の FAQ とコード内の注記に記載されています。
テーマのロケーションにレイアウトを出力する
vendix_theme/location フィルターは、Elementor Theme Builder のロケーション名 header、footer、single、archive を受け取ります。そのロケーションに独自のレイアウトを出力するプラグインは true を返します。するとテーマはその場所に何も出力しません。
add_filter( 'vendix_theme/location', function ( $printed, $location ) {
if ( 'header' !== $location ) {
return $printed;
}
// Print your header here.
echo '<header class="my-header">…</header>';
return true;
}, 10, 2 );
headerとfooterはすべてのページで実行されます。singleは投稿、固定ページ(カート、チェックアウト、アカウントページを含む)、添付ファイルやその他の投稿タイプのエントリー、商品、404 ページで実行されます。archiveは投稿ページ、投稿アーカイブ、検索結果、ショップ、商品カテゴリーとタグで実行されます。- ロケーション名からは、どの種類のページが表示されているかはわかりません。リクエスト(投稿タイプ、
is_404()、is_cart()など)からテンプレートを選び、それ以外ではfalseを返してください。 singleまたはarchiveが出力される場合、テーマはその周囲にヘッダーとフッターのみを出力します。current_theme_supports( 'vendix-templates' )で、テーマがこの方式に対応していることを確認できます。
優先順位は、プラグインのレイアウト、Elementor Theme Builder、テーマ独自のパーツの順です。
アクション
| アクション | 実行される場所 |
|---|---|
vendix_theme/header_before | テーマヘッダーの前(ヘッダーの外側) |
vendix_theme/header_after_branding | ヘッダー行内、ロゴまたはサイトタイトルの直後 |
vendix_theme/header_actions | ヘッダー行の末尾。パーツは .vt-header-actions グループにまとめて並びます |
vendix_theme/header_after | テーマヘッダーの後(ヘッダーの外側) |
vendix_theme/footer_before | コンテンツの後、フッターの前(フッターの出力元に関係なく) |
vendix_theme/single_before_content | 投稿本文の直上(投稿 ID 付き) |
vendix_theme/single_after_content | 投稿本文の直下(投稿 ID 付き) |
vendix_theme/post_meta | 投稿のメタ情報行の末尾(投稿 ID 付き) |
vendix_theme/card_meta | 投稿カードのメタ情報行の末尾(投稿 ID 付き) |
vendix_theme/news_* | ニュース / マガジンサイトのニュース用の表示箇所: news_top_bar、news_ticker、news_post_meta、news_card_meta、news_before_content、news_after_content |
ヘッダーのアクションは、テーマが独自のヘッダーを出力する場合にのみ実行されます。シンプルなチェックアウトなどのミニマルヘッダーでは、ヘッダー行のアクションは表示されません。透過ヘッダーはページ上部に重なり、その前後に出力されたパーツを覆ってしまいます。まず vendix_theme_header_transparent() を確認し、テーマがニュースのトップバーで行っているように、そのパーツを出力しないようにしてください。
投稿のアクションはすべてのサイトタイプで実行されます。ニュースサイトでは vendix_theme/news_* アクションはそのままの位置にあり、一般的なアクションはその後に続きます。ただし vendix_theme/single_after_content だけは vendix_theme/news_after_content の前に実行されます。
フィルター
| フィルター | 変更される内容 |
|---|---|
vendix_theme/site_type | サイトタイプ: business、store、news |
vendix_theme/defaults | すべてのテーマオプションのデフォルト値(サイトタイプ付き) |
vendix_theme/header_minimal | テーマヘッダーにロゴまたはサイトタイトルのみを表示するかどうか |
vendix_theme/footer_minimal | テーマフッターにフッターテキストのみを表示するかどうか |
vendix_theme/page_options_post_id | ショップなど、固定ページが代表するビューで、ページレイアウトのオプションを適用する投稿 |
vendix_theme/palette | ブロックエディターのパレットに使うデザインシステムの色 |
vendix_theme/setup_url | ウェルカムページに表示する、プラグインのガイド付きセットアップのアドレス |
vendix_theme/setup_complete | プラグインのガイド付きセットアップが完了したかどうか(完了するとセットアップの通知が非表示になります) |
プラグインは vendix_theme_site_type() でサイトタイプを取得することもできます。
テーマに色とフォントを渡す
- 色:
vendix_theme/paletteフィルターは空の配列を受け取ります。デザインシステムの色を、キーと 16 進カラーの組で返してください。キーはprimary、secondary、accent、heading、text、muted、border、bg_light、bg_darkです。テーマは有効な 16 進カラーをすべてブロックエディターのパレットに使用し、何も渡されない場合は独自のパレットを維持します。サイト自体は--vendix-color-*CSS 変数を読み込みます。 - 文字: ルート要素に CSS 変数
--vendix-type-{body|h1|h2|h3|h4|h5|h6|menu}-{family|size|size-tablet|size-mobile|weight|line-height|letter-spacing|transform}を、値がある場合のみ設定します。テーマはこれらを本文、見出し、テーマメニュー、ニュース投稿の本文・タイトル・見出しに使用し、未設定の場合は独自の値を使います。タブレット用サイズは 1024 ピクセルまで、スマートフォン用サイズは 767 ピクセルまで適用されます。
CSS フック
| フック | 示す内容 |
|---|---|
<html> の vt-sticky-header クラス | テーマの固定ヘッダーが表示されている |
<html> の --vt-sticky-header-height 変数 | 閉じた状態の固定ヘッダーの高さ(その下に固定するパーツ用) |
<html> の vt-menu-open クラス | スマートフォンのメニューが開いている |
vt-header-slot クラス | ロゴの横の領域。デスクトップではメニューが独立した行に移動し、タブレットとスマートフォンではこの領域が 1 行全体を占めます |
--vt-back-to-top-offset 変数 | 画面下部に固定されたプラグインのパーツに合わせて、トップへ戻るボタンを上に移動します |
<body> の vt-type-business、vt-type-store、vt-type-news クラス | サイトタイプ |
ヘッダーが固定されていない場合、プラグインまたは Elementor Theme Builder がヘッダーを出力している場合、ヘッダーが非表示の場合は、固定ヘッダーのクラスと変数は付与されません。