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

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

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

提供: WordPress Codex 日本語版
移動先: 案内検索
(en:Include Tags 2007年2月16日 (金) 00:34 Raddaqii 版)
 
 
(6人の利用者による、間の24版が非表示)
1行目: 1行目:
The Template '''include tags''' are used within one [[Templates|Template]] file (for example <tt>index.php</tt>) to execute the [[Glossary#HTML|HTML]] and [[Glossary#PHP|PHP]] found in another template file (for example <tt>header.php</tt>).  [http://www.php.net PHP] has a built in [http://us3.php.net/manual/en/function.include.php include()] statement for this purpose, but these WordPress template tags make including certain specific files much easier.
+
{{テーマ・テンプレートガイド|テンプレート}}
  
See [[Using Themes]] and [[Theme Development]] for more information about Templates and Themes.
 
  
== The Header Template ==
+
テンプレート'''インクルードタグ'''は、ある[[テンプレート]]ファイル(例えば <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 テンプレートタグを使えば、より簡単に特定のファイルを読み込めます。
  
&lt;?php get_header(); ?>
+
テンプレートとテーマについてのさらなる情報は、[[Using Themes|テーマの使い方]] ならびに [[テーマの作成]] をご覧ください。インクルードタグを用いて一つのウェブページを構成する仕組みについては、[[テンプレート入門]]で説明しています。
  
This tag includes the file <tt>header.php</tt> from your current theme's directory.  If that file is not found, it will instead include <tt>wp-content/themes/default/header.php</tt>.
+
<div id="Function_Reference">
 +
== 関数リファレンス ==
 +
</div>
  
== The Footer Template ==
+
{| cellspacing="10" width="100%"
 +
|- valign="top"
 +
| width="50%" |
  
&lt;?php get_footer(); ?>
+
{| cellspacing="10" style="width: 100%;"
 +
|- style="background:#464646; color:#e2e2e2;font-size:110%;line-height:1.8em"
 +
! '''一般的なファイルを読み込む'''
 +
|-
 +
|
 +
* <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>
 +
|}
  
This tag includes the file <tt>footer.php</tt> from your current theme's directory.  If that file is not found, it will instead include <tt>wp-content/themes/default/footer.php</tt>.
+
| width="50%" |
  
== The Sidebar Template ==
+
{| cellspacing="10" style="width: 100%;"
 +
|- style="background:#464646; color:#e2e2e2;font-size:110%;line-height:1.8em"
 +
! '''その他のコンポーネントを読み込む'''
 +
|-
 +
|
 +
* <tt>[[関数リファレンス/get_search_form | get_search_form()]]</tt>
 +
* <tt>[[関数リファレンス/comments_template | comments_template()]]</tt>
 +
 
 +
 
 +
|}
 +
 
 +
|}
 +
 
 +
 
 +
<div id="The_Header_Template">
 +
 
 +
== ヘッダーテンプレート ==
 +
</div>
 +
 
 +
<?php get_header(); ?>
 +
 
 +
<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>
 +
 
 +
<?php get_footer(); ?>
 +
 
 +
<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>
  
 
  <?php get_sidebar(); ?>
 
  <?php get_sidebar(); ?>
  
This tag includes the file <tt>sidebar.php</tt> from your current theme's directory. If that file is not found, it will instead include <tt>wp-content/themes/default/sidebar.php</tt>.
+
<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>
 +
 
 +
<?php get_template_part(); ?>
 +
 
 +
<code>[[関数リファレンス/get_template_part | get_template_part()]]</code> タグは、現在のテーマディレクトリから、ヘッダー、サイドバー、フッター以外のテンプレートパーツ <code>{slug}.php</code> または <code>{slug}-{name}.php</code> ファイルを読み込みます。
 +
 
 +
<div id="The_Search_Form_Template">
  
<?php get_sidebar('right'); ?>
+
== 検索フォームテンプレート ==
 +
</div>
  
Causes the template <code>TEMPLATEPATH . 'sidebar-right.php'</code> to be included.  Note: the ability to specify a particular sidebar, meaning more than one sidebar template can be used in a theme, was added with [[Version 2.5]].
+
<?php get_search_form(); ?>
  
== The Comments Template ==
+
The <code>[[関数リファレンス/get_search_form | get_search_form()]]</code> タグは、現在のテーマディレクトリから <code>searchform.php</code> ファイルを読み込みます。このファイルが無いときは、代わりに検索フォームが生成されます。
  
&lt;?php comments_template(); ?>
+
詳しくは [[関数リファレンス/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]] を参照してください。
  
This tag includes the file <tt>comments.php</tt> from your current theme's directory.  If that file is not found, it will instead include <tt>wp-content/themes/default/comments.php</tt>.  To display comments on the main index or archive pages, you'll need to set the <tt>$withcomments</tt> variable to <tt>"1"</tt> before calling this tag.
+
<div id="The_Comments_Template">
  
== Including Any Template ==
+
== コメントテンプレート ==
 +
</div>
  
WordPress offers the above tags for including those specific [[Templates]], but there is also a convenient way to include ''any'' file. To do so, you will need to use the <tt>[http://us2.php.net/manual/en/function.include.php include]</tt> [[Glossary#PHP|PHP]] function, and a constant WordPress conveniently defines for you to make things easy: <tt>TEMPLATEPATH</tt>.
+
  <?php comments_template(); ?>
  
Suppose you want to include a file called <tt>header2.php</tt>. Just insert the following line in your template where you want that file's information to appear.
+
このタグは、現在のテーマディレクトリから <code>comments.php</code> ファイルを読み込みます。このファイルが無いときは、代わりに {{Trac|wp-includes/theme-compat/comments.php}} を読み込みます。メインインデックスページやアーカイブページにコメントを表示するには、このタグを呼ぶ前に、変数 <code>$withcomments</code> に <code>"1"</code> をセットする必要があります。
  
&lt;?php include (TEMPLATEPATH . '/header2.php'); ?>
+
<div id="Example">
 +
== 用例 ==
 +
</div>
  
You could, for example, use this as a means of including a different header instead of the normal <tt>header.php</tt> which would be included with <tt>[[#The Header Template|get_header()]]</tt>.
+
次に示すのは、''極めて''簡素な "HTTP 404: Not Found" エラー用テンプレートの例です(<code>404.php</code> として[[テーマの作成|テーマ]]に加えます)。
  
'''NOTE''':  <tt>TEMPLATEPATH</tt> is a reference to the absolute path to the current theme directory (without the / at the end).  For information on referencing URIs rather than including files, see [[Theme Development#Referencing Files From a Template|Referencing Files From a Template]].
+
<pre>
 +
<?php get_header(); ?>
 +
<?php get_template_part('nav'); ?>
 +
<h2>Error 404 - Not Found</h2>
 +
<?php get_sidebar(); ?>
 +
<?php get_footer(); ?>
 +
</pre>
  
== Example ==
+
<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>.|オプション}}
  
The following is a ''very'' simple example of a template for an "HTTP 404: Not Found" error (which you could include in your [[Theme Development|Theme]] as <tt>404.php</tt>).
+
[[#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>|オプション}}
  
&lt;?php get_header(); ?>
+
== 変更履歴 ==
&lt;h2>Error 404 - Not Found</h2>
+
&lt;?php get_sidebar(); ?>
+
&lt;?php get_footer(); ?>
+
  
== Parameters ==
+
* [[Version 3.0|3.0]] :
 +
** [[#Custom Template files|<code>get_template_part()</code>]]は、その他のテンプレートファイルをインクルードするのに追加しました。
 +
* [[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>]] は、検索フォームをインクルードするのに追加しました。
 +
* [[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>]]は、headerテンプレートをインクルードするのに追加しました。
 +
** [[#The Footer Template|<code>get_footer()</code>]]は、footerテンプレートをインクルードするのに追加しました。
 +
** [[#The Sidebar Template|<code>get_sidebar()</code>]]は、sidebarテンプレートをインクルードするのに追加しました。
  
These tags do not accept any parameters.
+
== ソースコード ==
 +
{{BrowseSource|wp-includes/general-template.php}}
  
<!-- == Related ==
+
{{原文|Include Tags|133582}}<!-- 19:21, 27 July 2013 Kuzmanov -->
  
{{Tag General Tags}}
+
<!-- {{Include Tags}} 日本語版では、個別ページは特に設けなくてよいと思うのでコメントアウト -->
 +
{{PHP Function Tag Footer}}<!-- パラメータの渡し方へのリンクはあった方がいいので、Wikiテンプレートの内容変更・改名とも保留 -->
 +
{{DEFAULTSORT:いんくるうとたく}}
 +
[[Category:デザインとレイアウト]]
 +
[[Category:wp2.5]]
 +
[[Category:wp2.7]]
  
{{No Param Tag Footer}}
+
[[en:Include Tags]]
-->
+
[[pt:Include Tags]]
{{No Param Tag Footer}}
+
[[Category:Design and Layout]]
+

2015年7月20日 (月) 07:55時点における最新版


テンプレートインクルードタグは、あるテンプレートファイル(例えば index.php)の中で、他のテンプレートファイル(例えば header.php)の HTMLPHP を実行するために使います。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 関数型パラメータの渡し方関数リファレンステンプレートタグ目次もご覧ください。