「インクルードタグ」の版間の差分

2011年1月17日 (月) 15:35時点における版

テンプレートインクルードタグは、あるテンプレートファイル（例えば index.php）の中で、他のテンプレートファイル（例えば header.php）の HTML や PHP を実行するために使います。PHP にはこの用途の include() 文がありますが、以下の WordPress テンプレートタグを使えば、より簡単に特定のファイルを読み込めます。

テンプレートとテーマについてのさらなる情報は、テーマの使い方 ならびに テーマの作成 をご覧ください。インクルードタグを用いて一つのウェブページを構成する仕組みについては、テンプレート入門で説明しています。

<?php get_header(); ?>

このタグは、現在のテーマディレクトリから header.php ファイルを読み込みます。このファイルがないときは、代わりに wp-content/themes/default/header.php を読み込みます。

<?php get_footer(); ?>

このタグは、現在のテーマディレクトリから footer.php ファイルを読み込みます。このファイルが無いときは、代わりに wp-content/themes/default/footer.php を読み込みます。

<?php get_sidebar(); ?>

このタグは、現在のテーマディレクトリから sidebar.php ファイルを読み込みます。このファイルが無いときは、代わりに wp-content/themes/default/sidebar.php を読み込みます。

ファイル名の指定

WordPress 2.5 以上では、パラメータとして、サイドバーテンプレートのファイル名（sidebar-この部分.php）を指定できます。テンプレートに TEMPLATEPATH . 'sidebar-2.php' を読み込ませるには、次のように書きます。

<?php get_sidebar('2'); ?>

例えば、ウェブページの左右にサイドバーを設けたり、ページによってサイドバーテンプレートを使い分けるなど、テーマ内で二つ以上のサイドバーテンプレートを扱いたい場合に利用できます。

<?php get_search_form(); ?>

This tag includes the file searchform.php from your current theme's directory. If that file is not found, it will generate the search form.

See also get_search_form and Migrating Plugins and Themes to 2.7 for more detail.

<?php comments_template(); ?>

このタグは、現在のテーマディレクトリから comments.php ファイルを読み込みます。このファイルが無いときは、代わりに wp-content/themes/default/comments.php を読み込みます。メインインデックスページやアーカイブページにコメントを表示するには、このタグを呼ぶ前に、変数 $withcomments に "1" をセットする必要があります。

WordPress には、これらの特定のテンプレートを読み込むために上記のタグがありますが、どのようなファイルでも読み込める便利な方法もあります。それには、PHP の include 文と、誰にでも簡単に使えるよう WordPress で定義されている定数 TEMPLATEPATH を使います。

仮に header2.php というファイルを読み込みたいとしましょう。このファイルの内容を表示したいテンプレートの中に、次の行を挿入するだけです。

<?php include( TEMPLATEPATH . '/header2.php' ); ?>

これは例えば、get_header() で読み込まれる通常の header.php の替わりに、別のヘッダを読み込む手段として使えます。 他の用例と説明がテンプレート入門にあります。

注：

• TEMPLATEPATH は、現在のテンプレートディレクトリへの絶対パスへの参照です（末尾の / を除く）。ファイルの読み込みではなく URI参照についての情報であれば、テンプレートからのファイルの参照をご覧ください。
• STYLESHEETPATH は子テーマの中にあるファイルの読み込みに使うべきです。

次に示すのは、極めて簡素な "HTTP 404: Not Found" エラー用テンプレートの例です（404.php としてテーマに加えます）。

<?php get_header(); ?>
<h2>Error 404 - Not Found</h2>
<?php get_sidebar(); ?>
<?php get_footer(); ?>

変更履歴

• 2.7 :
  • The name parameter was added to get_header() and get_footer().
  • get_search_form() was added to include the search form.
• 2.5 : get_sidebar() に name（テンプレート名）パラメータが追加されました。
• 1.5 :
  • get_header() was added to include the template header.
  • get_footer() was added to include the template footer.
  • get_sidebar() was added to include the template sidebar.

ソースコード

wp-includes/general-template.php

最新英語版： WordPress Codex » Include Tags （最新版との差分）