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

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

関数リファレンス/load template

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

この項目「関数リファレンス/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最新版との差分