WordPressのhome_url()関数リファレンス
- 2025/07/07
- REFERENCE
- WordPressの関数
- 0comments
- 21views
- 約3分で読めます
WordPressのテーマ開発において、サイト内のページへのリンクを生成するために使用されるhome_url()
関数の完全リファレンスです。
目次
関数の概要
定義
home_url()
は、WordPressサイトのホームURLを取得する関数です。
目的
- サイト内のページへの絶対URLを動的に生成
- 環境に依存しないリンクの作成
- WordPressの設定に基づいた正しいURLの出力
基本動作
WordPressの管理画面「設定」→「一般」で設定されている「サイトアドレス(URL)」を基準として、指定されたパスを結合したURLを返します。
基本構文
home_url( $path, $scheme );
パラメータ
$path(文字列、オプション)
- デフォルト値:
''
(空文字列) - 説明: ホームURLに追加するパス
- 例:
'about'
,'contact'
,'category/news'
$scheme(文字列、オプション)
- デフォルト値:
null
- 説明: URLのプロトコルを指定
- 指定可能な値:
'http'
– HTTPプロトコルを強制'https'
– HTTPSプロトコルを強制'relative'
– プロトコル相対URL(//example.com/path/
)null
– サイトの設定に従う
明確な意図がない限りプロトコルは指定せず、Webサイトのプロトコルに従ってください。
戻り値
データ型: 文字列(string)
内容: 完全なURL文字列
例:
// パラメータなしの場合
home_url(); // "https://example.com"
// パスを指定した場合
home_url('about'); // "https://example.com/about"
// プロトコルを指定した場合
home_url('about', 'http'); // "http://example.com/about"
使用例
基本的な使用例
ホームページのURL
<?php echo home_url(); ?>
// 出力: https://example.com
特定のページのURL
<?php echo home_url('about'); ?>
// 出力: https://example.com/about
カテゴリーページのURL
<?php echo home_url('category/news'); ?>
// 出力: https://example.com/category/news
プロトコル指定の使用例
明確な意図がない限りプロトコルは指定せず、Webサイトのプロトコルに従ってください。
HTTPを強制
<?php echo home_url('about', 'http'); ?>
// 出力: http://example.com/about
HTTPSを強制
<?php echo home_url('about', 'https'); ?>
// 出力: https://example.com/about
プロトコル相対URL
<?php echo home_url('about', 'relative'); ?>
// 出力: //example.com/about
HTML内での使用例
ナビゲーションリンク
<nav>
<ul>
<li><a href="<?php echo home_url(); ?>">ホーム</a></li>
<li><a href="<?php echo home_url('about'); ?>">会社概要</a></li>
<li><a href="<?php echo home_url('contact'); ?>">お問い合わせ</a></li>
</ul>
</nav>
フォームのaction属性
<form action="<?php echo home_url('search'); ?>" method="get">
<input type="text" name="s" placeholder="検索...">
<button type="submit">検索</button>
</form>
注意事項
echoの必要性
❌ 間違った使用法
<a href="<?php home_url('about'); ?>">リンク</a>
✅ 正しい使用法
<a href="<?php echo home_url('about'); ?>">リンク</a>
理由: home_url()
は値を返すだけで、出力はしません。出力するにはecho
が必要です。
まとめ
home_url()
関数は、WordPressテーマ開発において環境に依存しない信頼性の高いURL生成を可能にする重要な関数です。
基本的な使用パターン
<?php echo home_url(); ?> // ホームページ
<?php echo home_url('about'); ?> // 特定のページ
重要なポイント
- 出力には
echo
が必要 - WordPressの設定に基づいて動的にURL生成
- 環境の違いを自動的に吸収