WEB制作のための情報サイト / unazuki Library

get_theme_file_uri()

基本構文と使い方(引数・実行結果)

基本構文

テーマディレクトリのURLを取得します。子テーマ利用時は子テーマディレクトリのURLを取得します。

get_theme_file_uri($file);

引数

引数必須/任意引数に指定するもの
第1引数
$file
任意テーマからのパスを文字列で指定
初期値''(空の文字列)

実行結果

戻り値(返す値):有効化されているテーマディレクトリのURL(引数が指定されている場合はそこからのパスを含めたURL)を返します。
子テーマが有効な場合は、子テーマディレクトリのURLを返します。引数が指定されている場合は、子テーマディレクトリ内から優先してファイルの存在を確認します。(子テーマに指定のファイルがなければ親テーマ内で探す、という手順です。)
※表示するにはechoします。

例1.テーマディレクトリのURLを表示

echo get_theme_file_uri();

結果例:https:example.com/wp-content/themes/my_theme

例2.テーマディレクトリのURLを基準に特定のパスを指定したURLを表示

echo get_theme_file_uri('images/test.jpg');

結果例:https:example.com/wp-content/themes/my_theme/images/test.jpg

学習者向け補足情報

【引数とは】
テンプレートタグ(=関数)を実行する際に、引数を渡すことができるテンプレートタグがあります。引数は、関数の中で使われるので、渡す引数の値によって実行結果が変わってきます。何を処理したいのか、どのようなデータを取得したいのかによって渡す引数が変わります。

【引数について】

  • 指定できる引数の数はテンプレートタグによって異なります。(引数なしもあり)
  • 引数ごとに必須 / 任意が決まっています。(必須は必ず指定、任意は指定しなければ初期値)
  • 引数名(例:$post)は仕様の便宜上の名前と考えてください。(この名前自体はテンプレートタグ実行に関係しません。各引数に何を指定するのかを理解していればOKです。)

よくある使い方

URLを無害化するテンプレートタグ esc_url() とあわせて使います。

<?php echo esc_url(get_theme_file_uri('/img/example.jpg')); ?>

参考コード

下記例ではテーマディレクトリ内に格納された任意の画像を表示します。

<img src="<?php echo esc_url(get_theme_file_uri('/img/example.jpg')); ?>" alt="">

※当サイトでは初期値とデフォルト値の言葉の定義を区別せず、原則統一して初期値を採用しています。

関連するテンプレートタグ

テンプレートタグ 説明
wp_get_attachment_image_src() 指定した添付画像(管理画面からメディアに登録された画像)の情報を取得する。
get_template_directory_uri() テーマディレクトリのURLを取得します。子テーマ利用時も常に親テーマのURLを取得します。
wp_get_attachment_image() 指定した添付画像(管理画面からメディアに登録された画像)のimg要素を取得する。
home_url() トップページのURLを取得します。