get_home_url

(3.0.0以降)
get_home_url - 任意のブログのホーム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

関連

  • get_site_url - 任意のブログのサイトURLを取得する
  • home_url - 現在のブログのホームURLを取得する

お勧めコンテンツ

the_date関数で投稿日を確実に表示する(2011年12月20日 登録)

投稿記事の投稿日時を表示する際、the_date関数を使用することが多いだろう。このthe_date関数はphpのdate関数と同じパラメータを指定することで、好みの日時フォーマットで投稿日時を表示できるのだが、ある条件の場合に投稿日時を表示しない。最初にこの現象に遭遇したときは、ちょっと悩まされた。

canvasタグを投稿したい(2013年12月27日 登録)

以前「投稿内容のid属性などを保存するための対策」で取り上げたように、WordPressでは投稿に記述できるHTMLタグが制限されている。同コラムでこの制限を調整する対策を紹介しているが、3.5以降ではフィルター関数を登録して対応できるようだ。

Slightly troublesome permalink:プラグイン作ってみました(2012年2月9日 登録)

カテゴリーを含んだパーマリンクを設定している場合、複数のカテゴリーを指定した投稿記事のパーマリンクのURLに目的のカテゴリーとは異なるカテゴリーが適用された経験はないだろうか。このプラグインは、パーマリンクに適用されるカテゴリーをコントロールし、希望通りのパーマリンクを設定します。

カスタム投稿タイプの投稿保存には専用アクションを使おう(2014年7月4日 登録)

カスタム投稿タイプを登録して、専用ウィジェット(meta_box)を使って拡張情報を入力させ、それらの情報をsave_postアクションで保存する。これまではこんな感じだったのだが、久しぶりにカスタム投稿タイプを使ったら、save_postアクションの前にsave_postに投稿タイプ名がくっついたアクションが追加されていた。

プラグインで注意が必要な関数(2013年11月27日 登録)

先日「Login rebuilder」という自作プラグインをアップデートした際、ユーザーさんからエラーになると連絡をいただいた。標準環境では問題なく、どうやら何らかのプラグインが影響しているらしい。

最終更新日時 : 2017-02-25 18:33