• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。（詳細）

【このWikiはいつでも誰でも編集できます】

インクルードタグ

提供: WordPress Codex 日本語版
移動先: 案内、 検索


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

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

一般的なファイルを読み込む
その他のコンポーネントを読み込む



ヘッダーテンプレート

<?php get_header(); ?>

get_header() タグは、現在のテーマディレクトリから header.php または header-{name}.php ファイルを読み込みます。 このファイルがないときは、代わりに wp-includes/theme-compat/header.php を読み込みます。 

<?php get_footer(); ?>

get_footer() タグは、現在のテーマディレクトリから footer.php または footer-{name}.php ファイルを読み込みます。このファイルが無いときは、代わりに wp-includes/theme-compat/footer.php を読み込みます。

サイドバーテンプレート

<?php get_sidebar(); ?>

get_sidebar() タグは、現在のテーマディレクトリから sidebar.php または sidebar-{name}.php ファイルを読み込みます。このファイルが無いときは、代わりに wp-includes/theme-compat/sidebar.php を読み込みます。

カスタムテンプレート

<?php get_template_part(); ?>

get_template_part() タグは、現在のテーマディレクトリから、ヘッダー、サイドバー、フッター以外のテンプレートパーツ {slug}.php または {slug}-{name}.php ファイルを読み込みます。

検索フォームテンプレート

<?php get_search_form(); ?>

The get_search_form() タグは、現在のテーマディレクトリから searchform.php ファイルを読み込みます。このファイルが無いときは、代わりに検索フォームが生成されます。

詳しくは get_search_form および Migrating Plugins and Themes to 2.7 を参照してください。

コメントテンプレート

<?php comments_template(); ?>

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

用例

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

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

パラメータ

get_header(), get_footer() and get_sidebar() は1つのパラメータを受け取ります:

$name
（文字列） （オプション） sidebar-{name}.php を読み込む。例: sidebar-right.php, header-single.php あるいは footer-8.php.
初期値： なし

get_template_part() は2つのパラメータを受け取ります:

$slug
（文字列） （必須） {slug}.php を読み込む。例: nav.php
初期値： なし
$name
（文字列） （オプション） {slug}-{name}.php を読み込む。例: nav-home.php
初期値： なし

変更履歴

  • 3.0 :
    • get_template_part()は、その他のテンプレートファイルをインクルードするのに追加しました。
  • 2.7 :
  • 2.5 : get_sidebar() に name（テンプレート名）パラメータが追加されました。
  • 1.5 :
    • get_header()は、headerテンプレートをインクルードするのに追加しました。
    • get_footer()は、footerテンプレートをインクルードするのに追加しました。
    • get_sidebar()は、sidebarテンプレートをインクルードするのに追加しました。

ソースコード

wp-includes/general-template.php

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


テンプレートタグへの PHP 関数型パラメータの渡し方、関数リファレンス、テンプレートタグ目次もご覧ください。
「http://wpdocs.osdn.jp/wiki/index.php?title=インクルードタグ&oldid=10744」から取得