当サイト、Codex 日本語版は今後積極的な更新は行わない予定です。後継となる新ユーザーマニュアルは、https://ja.wordpress.org/support/ にあります。
万が一、当サイトで重大な問題を発見した際などは、フォーラムWordSlack #docs チャンネルでお知らせください。</p>

テンプレートタグ/get home url

提供: WordPress Codex 日本語版
移動先: 案内検索

説明

適切なプロトコルとともに 'home' オプションを返します。プロトコルは is_ssl() が true なら 'https'、それ以外の場合は 'http' です。引数 $scheme'http' または 'https' の場合、is_ssl() による判定は上書きされます。

使い方

<?php get_home_url( $blog_id, $path, $scheme ); ?>

デフォルトの使い方

<?php echo esc_url( get_home_url() ); ?>

パラメータ

$blog_id
整数) (オプション) ブログ ID。
初期値: null (現在のブログ)
$path
文字列) (オプション) ホーム URL への相対パス。
初期値: なし
$scheme
文字列) (オプション) ホーム URL にコンテキストを与えるスキーマ。現在利用できるのは 'http', 'https', 'relative' (相対パス), および 'rest'
初期値: null

戻り値

(文字列) 
オプションのパス ($path) を追加したホーム URL リンク。

用例

参考

値を返す前に、apply_filters() を使ってホーム URL へ 'home_url' フィルターを適用します。

変更履歴

  • 3.0.0 : 新規導入。

ソースファイル

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

関連項目

リンク編集 edit_post_link, edit_comment_link, edit_tag_link, edit_bookmark_link /en


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


最新英語版: WordPress Codex » Function Reference/get_home_url最新版との差分