概要
get_home_url関数は、任意のブログのホームURLを取得するために使用されるワードプレスの関数です。この関数は、サイトのURLが必要な場合に非常に便利であり、以下のような機能を実装する際によく使われます。
- ナビゲーションメニューの作成
- フッターにリンクを設置
- ヘッダーでのサイトURLの参照
- プラグインやテーマの設定画面でのURL表示
- RSSフィードの生成
- ソーシャルメディア連携
- カスタムウィジェットでのリンク作成
- SEO関連機能の実装
構文
get_home_url( $blog_id = null, $path = '', $scheme = null );
パラメータ
$blog_id: サイトのIDを指定します。デフォルトは現在のブログのID。$path: ホームURLの後に追加するパス。デフォルトは空。$scheme: URLのスキーム（http, httpsなど）を指定します。デフォルトは未指定。
戻り値
指定されたパラメータに基づいて、ホームURL（文字列）を返します。
関連する関数
使用可能なバージョン
この関数は、WordPressのバージョン 2.0.0 以降で使用可能です。
コアファイルのパス
wp-includes/general-template.php
この関数のアクションでの使用可能性
| アクション | 使用可能性 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | |
| plugins_loaded | 〇 |
| wp_roles_init | |
| setup_theme | 〇 |
| after_setup_theme | 〇 |
| set_current_user | |
| init | 〇 |
| register_sidebar | |
| wp_loaded | 〇 |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | 〇 |
| template_redirect | 〇 |
| get_header | |
| wp_head | 〇 |
非推奨や削除されたバージョン
この関数は特定のバージョンで非推奨や削除されていません。