home_url() の使い方|説明・引数・注意点

説明

home_url() は、サイトのホームURL(トップページのURL)を返す関数です。

基本構文

home_url( string $path = '', string|null $scheme = null ): string

引数

  • $path:URLに付け足すパス
  • $scheme:http / https / relative

戻り値

ホームURLの文字列。

使い方(サンプル)

echo esc_url( home_url( '/contact/' ) );

注意点

  • 「設定 → 一般」の「サイトアドレス(URL)」が基準になります。
  • WordPress本体のインストール先を指す site_url() とは別物です。
  • 末尾スラッシュは自動では付きません。パスの先頭にスラッシュを付けます。

実務での使いどころ

  • サイトのトップページや、固定ページへのリンクを作るとき(home_url( '/about/' ))。
  • コードの中に、ドメインを直接書かないようにするとき。

よくあるミスと対処

  • URLを直接書いている。ドメインを変えたとき(テストから本番など)に、すべて直す必要が出る。
  • home_url() と site_url() を混同している。WordPressを、サブディレクトリに置いている場合は、値が異なる。
  • $path の先頭に / を付け忘れ、またはスラッシュが重なる。home_url( '/about/' ) のように書く。

NG例

echo '<a href="https://example.com/about/">会社概要</a>'; // ドメインを直接書いている

OK例

echo '<a href="' . esc_url( home_url( '/about/' ) ) . '">会社概要</a>';

使い分け早見表

関数 返すURL
home_url() サイトのトップページのURL(サイトアドレス)
site_url() WordPress本体が置かれたURL(WordPressアドレス)
admin_url() 管理画面のURL

関連項目

site_url()、get_home_url()、admin_url()

公式リファレンス:home_url() | Function | WordPress Developer Resources

コメント

タイトルとURLをコピーしました