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

home_url()

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

基本構文

トップページのURLを取得します。

home_url($path,$scheme);

引数

引数必須/任意引数に指定するもの
第1引数
$path
任意TOPページからのパスを文字列で指定
初期値''(空の文字列)
第2引数
$scheme
任意URLのスキーム名(httpやhttpsなど)を文字列で指定
初期値null
指定しなければ自動判別

実行結果

戻り値(返す値):トップページのURL
※表示するにはechoします。

例1.トップページのURLを表示

下記例ではシンプルにトップページのURLを取得します。

echo home_url();

例2.下層ページ /company/history/ のURLを表示

echo home_url('/company/history/');

結果例:https://example.com/company/history/

学習者向け補足情報

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

【引数について】

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

よくある使い方

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

<a href="<?php echo esc_url(home_url('/service/')); ?>">サービス</a>

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

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

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