テンプレートタグ/home url

説明

home_url テンプレートタグは、現在のブログのホーム URL を返します。オプションで引数 $path の内容を付加して返すこともできます。この関数は適切なプロトコルを判定します。is_ssl() /en が有効な場合は "https"、それ以外の場合は "http" です。引数 $scheme で "http" か "https" を指定すると、is_ssl() による判定は無視されます。

WordPressで ネットワークの作成 をしている場合は、代わりに network_home_url() を使ってください。

使い方

<?php home_url( $path, $scheme ); ?>

デフォルトの使い方

<?php echo esc_url( home_url( '/' ) ); ?>

パラメータ

$path

（文字列） （オプション） ホーム URL からの相対パス。

初期値： なし

$scheme

（文字列） （オプション） ホーム URL に使うスキーム。現在利用できるのは "http" と "https" と "relative"（相対パス）。

初期値： null

戻り値

(文字列) 

オプションの引数 $path の値を付加したホーム URL。

用例

$url = home_url();
echo esc_url( $url );

出力: http://www.example.com

(最後のスラッシュがないことに注意してください)

$url = home_url( '/' );
echo esc_url( $url );

出力: http://www.example.com/

$url = home_url( '/', 'https' );
echo esc_url( $url );

出力: https://www.example.com/

$url = home_url( 'example', 'relative' );
echo esc_url( $url );

出力: /example

参考

• get_home_url() を使用。
• オプション の 'home' を使用。

変更履歴

• 3.0.0 : 新規導入。

ソースファイル

home_url() は wp-includes/link-template.php にあります。

関連項目

WordPress ディレクトリ:
home_url()	ホーム URL	http://www.example.com
site_url()	サイトディレクトリ URL	http://www.example.com または http://www.example.com/wordpress
admin_url()	管理画面ディレクトリ URL	http://www.example.com/wp-admin
includes_url() /en	インクルードディレクトリ URL	http://www.example.com/wp-includes
content_url() /en	コンテンツディレクトリ URL	http://www.example.com/wp-content
plugins_url() /en	プラグインディレクトリ URL	http://www.example.com/wp-content/plugins
wp_upload_dir() /en	アップロードディレクトリ URL (配列を返す)	http://www.example.com/wp-content/uploads

関数リファレンス、テンプレートタグ目次もご覧ください。

最新英語版： WordPress Codex » Function Reference/home url （最新版との差分）