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

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

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

提供: WordPress Codex 日本語版
移動先: 案内、 検索
(TEMPLATEPATH, STYLESHEETPATH の説明を訂正・追加。)
(2.7: get_header と get_footer でパラメータ使用可能に。get_search_form 追加。未翻訳)
1行目: 1行目:
 
{{テーマ・テンプレートガイド|テンプレート}}
 
{{テーマ・テンプレートガイド|テンプレート}}
 +
{{NeedTrans|一部}}
 +
 
テンプレート'''インクルードタグ'''は、ある[[テンプレート]]ファイル（例えば <code>index.php</code>）の中で、他のテンプレートファイル（例えば <code>header.php</code>）の [[用語集#HTML|HTML]] や [[用語集#PHP|PHP]] を実行するために使います。[http://www.php.net PHP] にはこの用途の <code>[http://jp.php.net/manual/ja/function.include.php include()]</code> 文がありますが、以下の WordPress テンプレートタグを使えば、より簡単に特定のファイルを読み込めます。
 
テンプレート'''インクルードタグ'''は、ある[[テンプレート]]ファイル（例えば <code>index.php</code>）の中で、他のテンプレートファイル（例えば <code>header.php</code>）の [[用語集#HTML|HTML]] や [[用語集#PHP|PHP]] を実行するために使います。[http://www.php.net PHP] にはこの用途の <code>[http://jp.php.net/manual/ja/function.include.php include()]</code> 文がありますが、以下の WordPress テンプレートタグを使えば、より簡単に特定のファイルを読み込めます。
  
−
テンプレートとテーマについてのさらなる情報は、[[:ja:Using Themes|テーマの使い方]] ならびに [[テーマの作成]] をご覧ください。インクルードタグを用いて一つのウェブページを構成する仕組みについては、[[テンプレート入門]]で説明しています。
+
テンプレートとテーマについてのさらなる情報は、[[Using Themes|テーマの使い方]] ならびに [[テーマの作成]] をご覧ください。インクルードタグを用いて一つのウェブページを構成する仕組みについては、[[テンプレート入門]]で説明しています。
  
 
<div id="The_Header_Template">
 
<div id="The_Header_Template">
10行目: 12行目:
 
  <?php get_header(); ?>
 
  <?php get_header(); ?>
  
−
このタグは、現在のテーマディレクトリから <code>header.php</code> ファイルを読み込みます。このファイルがないときは、代わりに <code>wp-content/themes/default/header.php</code> を読み込みます。
+
このタグは、現在のテーマディレクトリから <code>header.php</code> ファイルを読み込みます。このファイルがないときは、代わりに {{BrowseSource|wp-content/themes/default/header.php}} を読み込みます。
  
 
<div id="The_Footer_Template">
 
<div id="The_Footer_Template">
18行目: 20行目:
 
  <?php get_footer(); ?>
 
  <?php get_footer(); ?>
  
−
このタグは、現在のテーマディレクトリから <code>footer.php</code> ファイルを読み込みます。このファイルが無いときは、代わりに <code>wp-content/themes/default/footer.php</code> を読み込みます。
+
このタグは、現在のテーマディレクトリから <code>footer.php</code> ファイルを読み込みます。このファイルが無いときは、代わりに {{BrowseSource|wp-content/themes/default/footer.php}} を読み込みます。
  
 
<div id="The_Sidebar_Template">
 
<div id="The_Sidebar_Template">
26行目: 28行目:
 
  <?php get_sidebar(); ?>
 
  <?php get_sidebar(); ?>
  
−
このタグは、現在のテーマディレクトリから <code>sidebar.php</code> ファイルを読み込みます。このファイルが無いときは、代わりに <code>wp-content/themes/default/sidebar.php</code> を読み込みます。
+
このタグは、現在のテーマディレクトリから <code>sidebar.php</code> ファイルを読み込みます。このファイルが無いときは、代わりに {{BrowseSource|wp-content/themes/default/sidebar.php}} を読み込みます。
  
 
=== ファイル名の指定 ===
 
=== ファイル名の指定 ===
34行目: 36行目:
  
 
例えば、ウェブページの左右にサイドバーを設けたり、ページによってサイドバーテンプレートを使い分けるなど、テーマ内で二つ以上のサイドバーテンプレートを扱いたい場合に利用できます。
 
例えば、ウェブページの左右にサイドバーを設けたり、ページによってサイドバーテンプレートを使い分けるなど、テーマ内で二つ以上のサイドバーテンプレートを扱いたい場合に利用できます。
 +
 +
<div id="The_Search_Form_Template">
 +
== The Search Form Template ==
 +
</div>
 +
 +
<?php get_search_form(); ?>
 +
 +
This tag includes the file <tt>searchform.php</tt> from your current theme's directory. If that file is not found, it will generate the search form.
 +
 +
See also [[Function Reference/get_search_form|get_search_form]]/[[:en:Function Reference/get_search_form|en]] and [[Migrating Plugins and Themes to 2.7#The Search Form Template Tag|Migrating Plugins and Themes to 2.7]] for more detail.
  
 
<div id="The_Comments_Template">
 
<div id="The_Comments_Template">
41行目: 53行目:
 
  <?php comments_template(); ?>
 
  <?php comments_template(); ?>
  
−
このタグは、現在のテーマディレクトリから <code>comments.php</code> ファイルを読み込みます。このファイルが無いときは、代わりに <code>wp-content/themes/default/comments.php</code> を読み込みます。メインインデックスページやアーカイブページにコメントを表示するには、このタグを呼ぶ前に、変数 <code>$withcomments</code> に <code>"1"</code> をセットする必要があります。
+
このタグは、現在のテーマディレクトリから <code>comments.php</code> ファイルを読み込みます。このファイルが無いときは、代わりに {{BrowseSource|wp-content/themes/default/comments.php}} を読み込みます。メインインデックスページやアーカイブページにコメントを表示するには、このタグを呼ぶ前に、変数 <code>$withcomments</code> に <code>"1"</code> をセットする必要があります。
  
 
<div id="Including_Any_Template">
 
<div id="Including_Any_Template">
51行目: 63行目:
 
仮に <code>header2.php</code> というファイルを読み込みたいとしましょう。このファイルの内容を表示したいテンプレートの中に、次の行を挿入するだけです。
 
仮に <code>header2.php</code> というファイルを読み込みたいとしましょう。このファイルの内容を表示したいテンプレートの中に、次の行を挿入するだけです。
  
−
  <?php include (TEMPLATEPATH . '/header2.php'); ?>
+
  <?php include( TEMPLATEPATH . '/header2.php' ); ?>
  
 
これは例えば、<code>[[#ヘッダテンプレート|get_header()]]</code> で読み込まれる通常の <code>header.php</code> の替わりに、別のヘッダを読み込む手段として使えます。
 
これは例えば、<code>[[#ヘッダテンプレート|get_header()]]</code> で読み込まれる通常の <code>header.php</code> の替わりに、別のヘッダを読み込む手段として使えます。
77行目: 89行目:
 
== 変更履歴 ==
 
== 変更履歴 ==
  
 +
* [[Version 2.7|2.7]] :
 +
** The ''name'' parameter was added to [[#The Header Template|<code>get_header()</code>]] and [[#The Footer Template|<code>get_footer()</code>]].
 +
** [[#The Search From Template|<code>get_search_form()</code>]] was added to include the search form.
 
* [[Version 2.5|2.5]] : <code>[[#サイドバーテンプレート|get_sidebar()]]</code> に ''<code>name</code>''（テンプレート名）パラメータが追加されました。<!-- http://trac.wordpress.org/ticket/5615 -->
 
* [[Version 2.5|2.5]] : <code>[[#サイドバーテンプレート|get_sidebar()]]</code> に ''<code>name</code>''（テンプレート名）パラメータが追加されました。<!-- http://trac.wordpress.org/ticket/5615 -->
 +
* [[Version 1.5|1.5]] :
 +
** [[#The Header Template|<code>get_header()</code>]] was added to include the template header.
 +
** [[#The Footer Template|<code>get_footer()</code>]] was added to include the template footer.
 +
** [[#The Sidebar Template|<code>get_sidebar()</code>]] was added to include the template sidebar.
 +
 +
== ソースコード ==
 +
{{BrowseSource|wp-includes/general-template.php}}
  
−
{{原文|Include Tags|70969}}<!-- 15:03, May 9, 2009 Bono 版 -->
+
{{原文|Include Tags|81257}}<!-- 14:59, 21 December 2009 Stallefish 版 -->
  
−
{{No Param Tag Footer}}
+
<!-- {{Include Tags}} 日本語版では、個別ページは特に設けなくてよいと思うのでコメントアウト -->
 +
{{PHP Function Tag Footer}}<!-- パラメータの渡し方へのリンクはあった方がいいので、Wikiテンプレートの内容変更・改名とも保留 -->
 
{{DEFAULTSORT:いんくるうとたく}}
 
{{DEFAULTSORT:いんくるうとたく}}
 
[[Category:デザインとレイアウト]]
 
[[Category:デザインとレイアウト]]
 
[[Category:wp2.5]]
 
[[Category:wp2.5]]
 +
[[Category:wp2.7]]
  
 
[[en:Include Tags]]
 
[[en:Include Tags]]
 +
[[pt:Include Tags]]

2010年1月6日 (水) 00:46時点における版

このページ「インクルードタグ」は一部未翻訳です。和訳や日本語情報を加筆してくださる協力者を求めています。

テンプレートインクルードタグは、あるテンプレートファイル（例えば 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'); ?>

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

The Search Form Template

<?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/en 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(); ?>


変更履歴

ソースコード

wp-includes/general-template.php

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


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