概要
get_template_directory_uri
関数は、WordPressのテーマのURLを取得するために使用されます。この関数を使用することで、テーマのディレクトリ内にあるリソース(スタイルシートや画像など)への正確なパスを簡単に記述することができます。
get_template_directory_uri
関数は、以下のような機能を実装する際によく使われます。
- テーマのスタイルシートを読み込む
- テーマ内の画像を表示する
- JavaScriptファイルをテーマから読み込む
- カスタムフォントをテーマで使用する
- テーマの設定ページにリソースを提供する
- 管理画面の独自スタイルを提供する
- テンプレートパートのファイルへのリンクを生成する
- テーマ内のアセットのURLを簡単に取得する
構文
get_template_directory_uri();
パラメータ
この関数にはパラメータはありません。
戻り値
この関数は、テーマディレクトリのURIを文字列として返します。
関連する関数
この関数を使用可能なバージョン
get_template_directory_uri
関数は、WordPress 2.1.0 以降で使用可能です。
コアファイルのパス
この関数は、wp-includes/theme.php
ファイルに含まれています。
この関数のアクションでの使用可能性
アクション | 使用可否 |
---|---|
mu_plugin_loaded | |
registered_post_type | |
plugins_loaded | |
wp_roles_init | |
setup_theme | 〇 |
after_setup_theme | 〇 |
set_current_user | |
init | 〇 |
register_sidebar | |
wp_loaded | |
send_headers | |
parse_query | |
pre_get_posts | |
wp | |
template_redirect | 〇 |
get_header | 〇 |
wp_head | 〇 |
サンプルコード
サンプル1: スタイルシートを読み込む
function my_theme_enqueue_styles() {
wp_enqueue_style('main-styles', get_template_directory_uri() . '/css/style.css');
}
add_action('wp_enqueue_scripts', 'my_theme_enqueue_styles');
このサンプルコードは、テーマのスタイルシート(style.css)を読み込む方法を示しています。
サンプル2: JavaScriptファイルを読み込む
function my_theme_enqueue_scripts() {
wp_enqueue_script('main-script', get_template_directory_uri() . '/js/script.js', array('jquery'), null, true);
}
add_action('wp_enqueue_scripts', 'my_theme_enqueue_scripts');
このコードは、jQuery依存のJavaScriptファイル(script.js)をテーマから読み込む例です。
サンプル3: 画像のパスを指定する
<img src="<?php echo get_template_directory_uri(); ?>/images/logo.png" alt="Logo">
このサンプルコードは、テーマディレクトリ内の画像(logo.png)を表示する方法を示しています。
サンプル4: カスタムフォントを読み込む
function my_theme_custom_fonts() {
wp_enqueue_style('custom-font', get_template_directory_uri() . '/fonts/custom-font.css');
}
add_action('wp_enqueue_scripts', 'my_theme_custom_fonts');
このコードは、カスタムフォントのCSSをテーマから読み込む例です。
サンプル5: テンプレートパートへのリンク
get_template_part('partials/content', 'page');
このサンプルは、get_template_part
関数を使用して、部分テンプレートへのリンクを取得する方法を示しています。
これらのサンプルは、get_template_directory_uri
関数を使用して、テーマのリソースやファイルへのパスを取得するさまざまな方法を示しています。