逆引きゴリラ

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

snow_monkey_template_part_root

ご注意

現在の Snow Monkey では、本フックの使用は非推奨です。

本フックではなく、snow_monkey_template_part_root_hierarchy を使用するのを推奨されています。

フックタイプ

フィルターフック

説明

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

補足説明

  • 「ルートディレクトリ」とは、テンプレートが読まれるディレクトリの root を指しています。
  • 対象のテンプレートファイルが該当のルートディレクトリに存在する場合、そのテンプレートファイルを読み込みます。
  • 対象のテンプレートファイルが、テンプレートのルートディレクトリに存在しない場合、テーマ内のディレクトリから読み込まれます。
  • ルートディレクトリの指定値は上書きされます。本フックの優先度がもっとも低い結果が反映されます。

引数

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

返却値

変数名タイプ説明
$root文字列(string)ルートディレクトリのパス名

サンプルコード

my-snow-monkey.php
<?php

  … 略 …

  add_filter(
    'snow_monkey_template_part_root',
    function( $root, $slug, $name, $vars ) {
      return __DIR__ . '/template_root';
    },
    10,
    4
  );