当サイト、Codex 日本語版は今後積極的な更新は行わない予定です。後継となる新ユーザーマニュアルは、https://ja.wordpress.org/support/ にあります。
万が一、当サイトで重大な問題を発見した際などは、フォーラムWordSlack #docs チャンネルでお知らせください。</p>

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

提供: WordPress Codex 日本語版
移動先: 案内検索
(コメントテンプレート: 英語版の差分反映)
(20:37, 21 January 2011 英語版を反映させました。一部未翻訳です。)
5行目: 5行目:
  
 
テンプレートとテーマについてのさらなる情報は、[[Using Themes|テーマの使い方]] ならびに [[テーマの作成]] をご覧ください。インクルードタグを用いて一つのウェブページを構成する仕組みについては、[[テンプレート入門]]で説明しています。
 
テンプレートとテーマについてのさらなる情報は、[[Using Themes|テーマの使い方]] ならびに [[テーマの作成]] をご覧ください。インクルードタグを用いて一つのウェブページを構成する仕組みについては、[[テンプレート入門]]で説明しています。
 +
 +
<div id="Function_Reference">
 +
== Function Reference ==
 +
</div>
 +
 +
{| cellspacing="10" width="100%"
 +
|- valign="top"
 +
| width="50%" |
 +
 +
{| cellspacing="10" style="width: 100%;"
 +
|- style="background:#464646; color:#e2e2e2;font-size:110%;line-height:1.8em"
 +
! '''Include Generic Files'''
 +
|-
 +
|
 +
* <tt>[[関数リファレンス/get_header | get_header()]]</tt>
 +
* <tt>[[関数リファレンス/get_footer | get_footer()]]</tt>
 +
* <tt>[[関数リファレンス/get_sidebar | get_sidebar()]]</tt>
 +
* <tt>[[関数リファレンス/get_template_part | get_template_part()]]</tt>
 +
|}
 +
 +
| width="50%" |
 +
 +
{| cellspacing="10" style="width: 100%;"
 +
|- style="background:#464646; color:#e2e2e2;font-size:110%;line-height:1.8em"
 +
! '''Include Other Components'''
 +
|-
 +
|
 +
* <tt>[[関数リファレンス/get_search_form | get_search_form()]]</tt>
 +
* <tt>[[関数リファレンス/comments_template | comments_template()]]</tt>
 +
 +
 +
|}
 +
 +
|}
 +
  
 
<div id="The_Header_Template">
 
<div id="The_Header_Template">
12行目: 47行目:
 
  <?php get_header(); ?>
 
  <?php get_header(); ?>
  
<tt>[[関数リファレンス/get_header | get_header()]]</tt> タグは、現在のテーマディレクトリから <code>header.php</code> または <code>header-{name}.php</code> ファイルを読み込みます。 このファイルがないときは、代わりに {{Trac|wp-includes/theme-compat/header.php}} を読み込みます。
+
<code>[[関数リファレンス/get_header | get_header()]]</code> タグは、現在のテーマディレクトリから <code>header.php</code> または <code>header-{name}.php</code> ファイルを読み込みます。 このファイルがないときは、代わりに {{Trac|wp-includes/theme-compat/header.php}} を読み込みます。
  
 
<div id="The_Footer_Template">
 
<div id="The_Footer_Template">
 
 
== フッタテンプレート ==
 
== フッタテンプレート ==
 
</div>
 
</div>
21行目: 55行目:
 
  <?php get_footer(); ?>
 
  <?php get_footer(); ?>
  
<tt>[[関数リファレンス/get_footer | get_footer()]]</tt> タグは、現在のテーマディレクトリから <code>footer.php</code> または <code>footer-{name}.php</code> ファイルを読み込みます。このファイルが無いときは、代わりに {{Trac|wp-includes/theme-compat/footer.php}} を読み込みます。
+
<code>[[関数リファレンス/get_footer | get_footer()]]</code> タグは、現在のテーマディレクトリから <code>footer.php</code> または <code>footer-{name}.php</code> ファイルを読み込みます。このファイルが無いときは、代わりに {{Trac|wp-includes/theme-compat/footer.php}} を読み込みます。
  
 
<div id="The_Sidebar_Template">
 
<div id="The_Sidebar_Template">
 
 
== サイドバーテンプレート ==
 
== サイドバーテンプレート ==
 
</div>
 
</div>
30行目: 63行目:
 
  <?php get_sidebar(); ?>
 
  <?php get_sidebar(); ?>
  
<code>[[関数リファレンス/get_sidebar | get_sidebar()]]</code> タグは、現在のテーマディレクトリから <code>sidebar.php</code> または <code>sidebar-{name}.php</code> ファイルを読み込みます。このファイルが無いときは、代わりに {{Trac|wp-includes/theme-compat/sidebar.php}} を読み込みます。
+
<code>[[関数リファレンス/get_sidebar | get_sidebar()]]</code> タグは、現在のテーマディレクトリから <code>sidebar.php</code> または <code>sidebar-{name}.php</code> ファイルを読み込みます。このファイルが無いときは、代わりに {{Trac|wp-includes/theme-compat/sidebar.php}} を読み込みます。
  
 
<div id="Custom_Template_files">
 
<div id="Custom_Template_files">
38行目: 71行目:
 
  <?php get_template_part(); ?>
 
  <?php get_template_part(); ?>
  
The <code>[[関数リファレンス/get_template_part | get_template_part()]]</code> tag includes the file <code>{slug}.php</code> or <code>{slug}-{name}.php</code> from your current theme's directory, a custom Include Tags other than header, sidebar, footer.
+
<code>[[関数リファレンス/get_template_part | get_template_part()]]</code> タグは、現在のテーマディレクトリから、ヘッダー、サイドバー、フッター以外のテンプレートパーツ <code>{slug}.php</code> または <code>{slug}-{name}.php</code> ファイルを読み込みます。
  
 
<div id="The_Search_Form_Template">
 
<div id="The_Search_Form_Template">
 
 
== The Search Form Template ==
 
== The Search Form Template ==
 
</div>
 
</div>
47行目: 79行目:
 
  <?php get_search_form(); ?>
 
  <?php get_search_form(); ?>
  
The <code>[[関数リファレンス/get_search_form | get_search_form()]]</code> tag includes the file <code>searchform.php</code> from your current theme's directory. If that file is not found, it will generate the search form.
+
The <code>[[関数リファレンス/get_search_form | get_search_form()]]</code> タグは、現在のテーマディレクトリから <code>searchform.php</code> ファイルを読み込みます。このファイルが無いときは、代わりに検索フォームが生成されます。
  
See also [[関数リファレンス/get_search_form|get_search_form]] and [[Migrating Plugins and Themes to 2.7#The Search Form Template Tag|Migrating Plugins and Themes to 2.7]] for more detail.
+
詳しくは [[関数リファレンス/get_search_form|get_search_form]] および [[Migrating Plugins and Themes to 2.7#The Search Form Template Tag|Migrating Plugins and Themes to 2.7]] を参照してください。
  
 
<div id="The_Comments_Template">
 
<div id="The_Comments_Template">
 
 
== コメントテンプレート ==
 
== コメントテンプレート ==
 
</div>
 
</div>
58行目: 89行目:
 
  <?php comments_template(); ?>
 
  <?php comments_template(); ?>
  
このタグは、現在のテーマディレクトリから <code>comments.php</code> ファイルを読み込みます。このファイルが無いときは、代わりに {{BrowseSource|wp-includes/theme-compat/comments.php}} を読み込みます。メインインデックスページやアーカイブページにコメントを表示するには、このタグを呼ぶ前に、変数 <code>$withcomments</code> に <code>"1"</code> をセットする必要があります。
+
このタグは、現在のテーマディレクトリから <code>comments.php</code> ファイルを読み込みます。このファイルが無いときは、代わりに {{Trac|wp-includes/theme-compat/comments.php}} を読み込みます。メインインデックスページやアーカイブページにコメントを表示するには、このタグを呼ぶ前に、変数 <code>$withcomments</code> に <code>"1"</code> をセットする必要があります。
 
+
<div id="Including_Any_Template">
+
 
+
== その他のテンプレートの読み込み ==
+
</div>
+
'''[[Version 2.5|WordPress 3.0]] 以上'''の場合は、[[関数リファレンス/get_template_part]]をご確認ください
+
 
+
WordPress には、これらの特定の[[テンプレート]]を読み込むために上記のタグがありますが、''どのようなファイルでも''読み込める便利な方法もあります。それには、[[用語集#PHP|PHP]] の <code>[http://jp.php.net/manual/ja/function.include.php include]</code> 文と、誰にでも簡単に使えるよう WordPress で定義されている定数 <code>TEMPLATEPATH</code> を使います。
+
 
+
仮に <code>header2.php</code> というファイルを読み込みたいとしましょう。このファイルの内容を表示したいテンプレートの中に、次の行を挿入するだけです。
+
 
+
<?php include( TEMPLATEPATH . '/header2.php' ); ?>
+
 
+
これは例えば、<code>[[#ヘッダテンプレート|get_header()]]</code> で読み込まれる通常の <code>header.php</code> の替わりに、別のヘッダを読み込む手段として使えます。
+
他の用例と説明が[[テンプレート入門#Template Files Within Template Files|テンプレート入門]]にあります。
+
 
+
'''注''':
+
* <code>TEMPLATEPATH</code> は、現在のテンプレートディレクトリへの絶対パスへの参照です(末尾の <code>/</code> を除く)。ファイルの読み込みではなく URI参照についての情報であれば、[[テーマの作成#Referencing Files From a Template|テンプレートからのファイルの参照]]をご覧ください。
+
* <tt>STYLESHEETPATH</tt> は[[テーマの作成#Theme Style Sheet|子テーマ]]の中にあるファイルの読み込みに使うべきです。
+
  
 
<div id="Example">
 
<div id="Example">
 
 
== 用例 ==
 
== 用例 ==
 
</div>
 
</div>
88行目: 99行目:
 
<pre>
 
<pre>
 
<?php get_header(); ?>
 
<?php get_header(); ?>
 +
<?php get_template_part('nav'); ?>
 
<h2>Error 404 - Not Found</h2>
 
<h2>Error 404 - Not Found</h2>
 
<?php get_sidebar(); ?>
 
<?php get_sidebar(); ?>
93行目: 105行目:
 
</pre>
 
</pre>
  
<!-- パラメータセクションは上に記載済みなので省略 -->
+
<div id="Parameters">
 +
== パラメータ ==
 +
</div>
 +
[[#The Header Template|<code>get_header()</code>]], [[#The Footer Template|<code>get_footer()</code>]] and [[#The Sidebar Template|<code>get_sidebar()</code>]] は1つのパラメーターを受け取ります:
 +
{{Parameter|$name|文字列|sidebar-{name}.php を読み込む。例: <code>sidebar-right.php</code>, <code>header-single.php</code> あるいは <code>footer-8.php</code>.|オプション}}
 +
 
 +
[[#Custom Template files|<code>get_template_part()</code>]] は2つのパラメーターを受け取ります:
 +
{{Parameter|$slug|文字列|{slug}.php を読み込む。例: <code>nav.php</code>}}
 +
{{Parameter|$name|文字列|{slug}-{name}.php を読み込む。例: <code>nav-home.php</code>|オプション}}
  
 
== 変更履歴 ==
 
== 変更履歴 ==
  
 +
* [[Version 3.0|3.0]] :
 +
** [[#Custom Template files|<code>get_template_part()</code>]] was added to include the template other generic files.
 
* [[Version 2.7|2.7]] :
 
* [[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 ''name'' parameter was added to [[#The Header Template|<code>get_header()</code>]] and [[#The Footer Template|<code>get_footer()</code>]].

2013年1月15日 (火) 16:49時点における版


このページは最新情報に追随して更新されていません。英語版のテーマハンドブックコードリファレンスをご確認ください。翻訳にご協力くださる方はぜひご相談ください


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

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

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

Include Generic Files
Include Other Components



ヘッダテンプレート

<?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 を読み込みます。

Custom Template files

<?php get_template_part(); ?>

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

The Search Form Template

<?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
初期値: なし

変更履歴

ソースコード

wp-includes/general-template.php

最新英語版: WordPress Codex » Include Tags最新版との差分


テンプレートタグへの PHP 関数型パラメータの渡し方関数リファレンステンプレートタグ目次もご覧ください。