逆引きゴリラ

News
2021/01/12 設定値の解説記事を 2 件追加しました。
  1. ホーム
  2. フック
  3. snow_monkey_template_part_root_hierarchy

snow_monkey_template_part_root_hierarchy

フックタイプ

フィルターフック

説明

テンプレートファイルが読まれる際のルートディレクトリの階層を設定します。

補足説明

  • 「ルートディレクトリ」とは、テンプレートが読まれるディレクトリの root を指しています。
  • ルートディレクトリは、このフックで設定された値を順に参照します。
  • 対象のテンプレートファイルが該当のルートディレクトリに存在する場合、そのテンプレートファイルを読み込みます。
  • 対象のテンプレートファイルが、すべてのテンプレートのルートディレクトリに存在しない場合、テーマ内のディレクトリから読み込まれます。
  • ルートディレクトリの階層が重複する場合は、並びの若い順で一意性が保たれます。
  • slug に関連するテンプレートファイルの読み込みの際は、本フックではなく snow_monkey_template_part_root_hierarchy_slug を使用するのを推奨されています。

引数

引数名タイプ説明
$hierarchy配列(array)ルートディレクトリの階層
$slug文字列(string)テンプレートファイルが読み込まれる際の slug
$name文字列(string)テンプレートファイルが読み込まれる際の name
$vars配列(array)テンプレートファイルが読み込まれる際の引数

返却値

変数名タイプ説明
$hierarchy配列(array)ルートディレクトリの階層

サンプルコード

my-snow-monkey.php
<?php

  … 略 …

  add_filter(
    'snow_monkey_template_part_root_hierarchy',
    function( $hierarchy, $slug, $name, $vars ) {
      $hierarchy[] = __DIR__ . '/template_root';
      return $hierarchy;
    },
    10,
    4
  );