Nishiki Pro テーマにはテンプレートファイルを読み込む get_template_part を拡張させた nishiki_pro_get_template_part という独自の関数があります。

今回は nishiki_pro_get_template_part を使ってテンプレートファイルの読み込み先を変更する方法を紹介します。

この方法を使えば、特定のページで出力する HTML を自分好みにカスタマイズすることもできます。

ただし、カスタマイズの難易度がそこそこ高いので、ご理解いただいた上で読み進めてください。

目次

• ディレクトリ構成
• サンプルコード
  • コード解説
  • フィルター名をつける時のコツ
• nishiki_pro_get_template_part を使ってテンプレートファイルを読み込んでいる場所はどこ？

ディレクトリ構成

今回は、以下のようなディレクトリ構成で「nishiki-pro-custom」という名前のプラグインを作成したと仮定します。

サンプルコード

プラグインディレクトリ内の index.php に以下のようにコードを書きます。

if ( ! function_exists( 'nishiki_pro_custom_archive_post_template' ) ) {
    function nishiki_pro_custom_archive_post_template( $file_path ){
        if( is_archive() ){ // 表示するページがアーカイブページの場合のみ処理する
            // 「プラグインディレクトリ/templates/parts/archive/post.php」ファイルが存在すれば差し替える
            $file_path = dirname(  __FILE__  ) . '/templates'; 
        }

        return $file_path;
    }

    add_filter( 'nishiki_pro_get_template_part_path_parts/archive/post', 'nishiki_pro_custom_archive_post_template' );
}

コード解説

nishiki_pro_get_template_part_{$path} フィルターを使って、テンプレートの読み込み先をプラグインディレクトリ内に変更しています。is_archive() はワードプレスの関数です。

フィルター名をつける時のコツ

上記のサンプルコードを例にすると nishiki_pro_get_template_part( 'parts/archive/post' ) のように「テーマディレクトリ/parts/archive/post.php」ファイルを読み込んでいる場合は「nishiki_pro_get_template_part_{$path}」フィルターの「{$path}」を「parts/archive/post」に置き換えて使えば OK です。

つまり、Nishiki Pro テーマ内で nishiki_pro_get_template_part を使ってテンプレートを読み込んでいる箇所はフックでいくらでも自分好みに差し替えてカスタマイズできる、ということです。

例えば「特定のページの HTML の出力を変えたい」なんて要望はわりとあると思いますので、機会があれば活用ください。

テーマ開発者の私も制作案件などで結構この方法を使っています。

nishiki_pro_get_template_part を使ってテンプレートファイルを読み込んでいる場所はどこ？

以下に一覧としてまとめましたので参考ください。

また、テーマファイル内のソースコードを読める方&フィルターフックの知識を持つ方前提の関数なので「nishiki_pro_get_template_part」を使って読み込んでいる箇所を実際に確認し、理解した上で利用ください。

ファイル名	nishiki_pro_get_template_part の第一引数（パス）
/archive.php	parts/archive/content
/footer.php	parts/footer/content
/front-page.php	parts/front/main-visual parts/front/section
/header.php	parts/header/meta parts/header/content
/index.php	parts/front/main-visual parts/archive/content
/search.php	parts/archive/content
/singular.php	parts/singular/content
/library/init.php	parts/archive/post
/parts/archive/content.php	parts/archive/post
/parts/header/content.php	parts/header/global-nav
/templates/content-full-width-title-none.php	parts/header/meta parts/header/content
/templates/content-full-width.php	parts/header/meta parts/header/content parts/singular/content
/templates/content-only.php	parts/header/meta
/templates/sidebar-bottom.php	parts/header/meta parts/header/content parts/singular/content
/templates/sidebar-left.php	parts/header/meta parts/header/content parts/singular/content
/templates/sidebar-none.php	parts/header/meta parts/header/content parts/singular/content
/templates/sidebar-right.php	parts/header/meta parts/header/content parts/singular/content