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

「関数リファレンス/load template」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(en:Function Reference/load_template 10:12, 26 December 2013 Mistercat 版を流し込み。)
 
(和訳完了。)
 
1行目: 1行目:
{{NeedTrans}}
+
{{CheckTrans}}
  
== Description ==
+
== 説明<span id="Description"></span> ==
Require once the template file with WordPress environment.
+
  
The globals are set up for the template file to ensure that the WordPress environment is available from within the function. The query variables are also available.  
+
WordPress 環境へテンプレートファイルを <tt>[http://php.net/manual/ja/function.require-once.php require_once]</tt> で読み込みます。
 +
 
 +
関数から WordPress 環境を使用可能とするため、テンプレートファイルに対して [[グローバル変数]] がセットアップされます。[[WordPress_Query_Vars|クエリ変数]]も使用可能です。
 +
 
 +
== 使い方<span id="Usage"></span> ==
  
== Usage ==
 
 
  <?php load_template( $_template_file, $require_once ) ?>
 
  <?php load_template( $_template_file, $require_once ) ?>
  
== Parameters ==
+
== パラメータ<span id="Parameters"></span> ==
{{Parameter|$_template_file|string|Path to template file.}}
+
{{Parameter|$require_once |bool|Whether to require_once or require.|optional|true}}
+
  
== Return Values ==
+
{{Parameter|$_template_file|文字列|テンプレートファイルのパス。}}
; (void) : This function does not return a value.
+
{{Parameter|$require_once|真偽値|require_once するか [http://php.net/manual/ja/function.require.php require] するか。|オプション|<tt>true</tt> - require_once}}
  
== Examples ==
+
== 戻り値<span id="Return_Values"></span> ==
 +
 
 +
; (void) : この関数は値を返しません。
 +
 
 +
== 用例<span id="Examples"></span> ==
 
<!-- Need creative examples. Feel free to link to external examples. -->
 
<!-- Need creative examples. Feel free to link to external examples. -->
  
===Loading a template in a plugin, but allowing theme and child theme to override template===
+
== テンプレートをプラグインへ読み込むがテーマや子テーマが上書き可能にする<span id="Loading a template in a plugin, but allowing theme and child theme to override template"></span> ==
  
 
<pre>
 
<pre>
33行目: 37行目:
 
</pre>
 
</pre>
  
== Notes ==
+
== 参考<span id="Notes"></span> ==
* Uses global: (<tt>object</tt>) [[クラスリファレンス/WP_Query|<tt>$wp_query</tt>]] to extract [http://us.php.net/manual/ja/function.extract.php <tt>extract()</tt>] global variables returned by the <tt>query_vars</tt> method while protecting the current values in these global variables:
+
 
** (<tt>unknown type</tt>) <tt>$posts</tt>
+
* グローバルの (<tt>オブジェクト</tt>) [[クラスリファレンス/WP_Query|<tt>$wp_query</tt>]] を使って <tt>query_vars</tt> メソッドが返すグローバル変数を [http://us.php.net/manual/ja/function.extract.php <tt>extract()</tt>] でセットしますが、下記のグローバル変数は現在の値を保護します:
** (<tt>unknown type</tt>) <tt>$post</tt>
+
** (<tt>不明な型</tt>) <tt>$posts</tt>
** (<tt>boolean</tt>) <tt>$wp_did_header</tt> Returns <tt>true</tt> if the WordPress header was already loaded. See the <tt>/wp-blog-header.php</tt> file for details.
+
** (<tt>オブジェクト</tt>) [[クラスリファレンス/WP_Post|<tt>$post</tt>]]
** (<tt>boolean</tt>) <tt>$wp_did_template_redirect</tt>
+
** (<tt>真偽値</tt>) <tt>$wp_did_header</tt> - WordPress のヘッダーがロード済みなら <tt>true</tt> を持つ。詳細は <tt>/wp-blog-header.php</tt> ファイルを参照。
** (<tt>object</tt>) <tt>$wp_rewrite</tt>
+
** (<tt>真偽値</tt>) <tt>$wp_did_template_redirect</tt>
** (<tt>object</tt>) [[クラスリファレンス/wpdb|<tt>$wpdb</tt>]]
+
** (<tt>オブジェクト</tt>) <tt>$wp_rewrite</tt>
** (<tt>string</tt>) <tt>$wp_version</tt> holds the installed WordPress version number.
+
** (<tt>オブジェクト</tt>) [[クラスリファレンス/wpdb|<tt>$wpdb</tt>]]
** (<tt>string</tt>) <tt>$wp</tt>
+
** (<tt>文字列</tt>) <tt>$wp_version</tt> - インストールされている WordPress のバージョン番号を持つ。
** (<tt>string</tt>) <tt>$id</tt>
+
** (<tt>文字列</tt>) <tt>$wp</tt>
** (<tt>string</tt>) <tt>$comment</tt>
+
** (<tt>文字列</tt>) <tt>$id</tt>
** (<tt>string</tt>) <tt>$user_ID</tt>
+
** (<tt>文字列</tt>) <tt>$comment</tt>
 +
** (<tt>文字列</tt>) <tt>$user_ID</tt>
 +
 
 +
== 変更履歴<span id="Change_Log"></span> ==
 +
 
 +
新規導入 : 1.5.0
  
== Change Log ==
+
== ソースファイル<span id="Source_File"></span> ==
Since: 1.5.0
+
  
== Source File ==
+
<tt>load_template()</tt> {{Trac|wp-includes/template.php}} にあります。
<tt>load_template()</tt> is located in {{Trac|wp-includes/template.php}}.
+
  
== Related ==
+
== 関連項目<span id="Related"></span> ==
  
 
{{Template_Functions}}
 
{{Template_Functions}}

2018年5月25日 (金) 19:08時点における最新版

この項目「関数リファレンス/load template」は、翻訳チェック待ちの項目です。加筆、訂正などを通して、Codex ドキュメンテーションにご協力下さい。

説明

WordPress 環境へテンプレートファイルを require_once で読み込みます。

関数から WordPress 環境を使用可能とするため、テンプレートファイルに対して グローバル変数 がセットアップされます。クエリ変数も使用可能です。

使い方

<?php load_template( $_template_file, $require_once ) ?>

パラメータ

$_template_file
文字列) (必須) テンプレートファイルのパス。
初期値: なし
$require_once
真偽値) (オプション) require_once するか require するか。
初期値: true - require_once

戻り値

(void) 
この関数は値を返しません。

用例

テンプレートをプラグインへ読み込むがテーマや子テーマが上書き可能にする

  if ( $overridden_template = locate_template( 'some-template.php' ) ) {
    // locate_template() returns path to file
    // if either the child theme or the parent theme have overridden the template
    load_template( $overridden_template );
  } else {
    // If neither the child nor parent theme have overridden the template,
    // we load the template from the 'templates' sub-directory of the directory this file is in
    load_template( dirname( __FILE__ ) . '/templates/some-template.php' );
  }

参考

  • グローバルの (オブジェクト) $wp_query を使って query_vars メソッドが返すグローバル変数を extract() でセットしますが、下記のグローバル変数は現在の値を保護します:
    • (不明な型) $posts
    • (オブジェクト) $post
    • (真偽値) $wp_did_header - WordPress のヘッダーがロード済みなら true を持つ。詳細は /wp-blog-header.php ファイルを参照。
    • (真偽値) $wp_did_template_redirect
    • (オブジェクト) $wp_rewrite
    • (オブジェクト) $wpdb
    • (文字列) $wp_version - インストールされている WordPress のバージョン番号を持つ。
    • (文字列) $wp
    • (文字列) $id
    • (文字列) $comment
    • (文字列) $user_ID

変更履歴

新規導入 : 1.5.0

ソースファイル

load_template()wp-includes/template.php にあります。

関連項目

テンプレート関数: locate_template(), load_template(), get_template(), get_template_part(), get_template_directory(), get_template_directory_uri(), get_page_templates() /en, comments_template(), get_query_template(), is_page_template()


関数リファレンステンプレートタグ目次もご覧ください。


最新英語版: WordPress Codex » Function Reference/load_template最新版との差分