get_home_url

説明

string get_home_url( [ int $blog_id = null [ , string $path = '' [ , string $scheme = null ] ] ] )
任意のブログ(サイト)のホームURLを取得する。ホームURLは、管理者ページの「設定」-「一般」の「サイトのアドレス(URL)」のこと。

パラメータ

  • $blog_id
    ホームURLを取得するブログIDを指定(省略時はnullで現在のブログとなる)。
  • $path
    ホームURLに追加するパス名を指定(省略時は'')。
  • $scheme
    スキーマ名として'http'または'https'を指定(省略時はnullで自動判別)。

返り値

任意のブログのホームURL(スキーマ名を含むフルパス名)を返す。

注意

特にありません。

使用例

  • 現在のブログのホームURLを取得する。
    <?php $home = get_home_url( null, '/' ); ?>
  • ブログIDが2のホームURLを取得する。
    <?php $blog_home = get_home_url( 2, '/' ); ?>

フィルター

[3.0.0]ホームURLを返す直前で'home_url'フィルターを呼び出す。パラメータ$urlには本関数で生成したホームURL、$pathには本関数が受け取った同名変数の内容、$orig_schemeには本館数が受け取った$schemeの内容、 $blog_idには本関数が受け取った同名変数の内容が格納される。
apply_filters( 'home_url', $url, $path, $orig_scheme, $blog_id );

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/link-template.php

最終更新 : 2018年05月27日 10:50



お勧め

個人データのエクスポートメール向けに追加された新フィルター(2020年4月2日 更新)

先週「WordPress 5.4 RC3」が公開され、正式リリースまであと1週間。ブロックエディターの機能強化が目立つわけですが、地味な変更点もちらほらと。今回はその中の1つ、「個人データのエクスポート」機能に関連するフィルターを紹介する。

決まった値を返すだけの関数群(2018年5月27日 更新)

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。

サイドバーの初期化はwidgets_initアクションで(2011年7月14日 更新)

ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。

Gutenbergでカスタムフィールドを使う(2018年8月10日 更新)

Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。

favicon.icoがWordPressロゴになる!?(2020年2月25日 更新)

先週「WordPress 5.4 Beta2」が公開され、来月末には正式リリース。タイミングよく三連休だったので、1つ前の「ニュース」で紹介されていた変更点から確認してみた。