概要
get_site_url 関数は、任意のブログのサイトURLを取得するための機能を提供します。この関数は、マルチサイト環境やシングルサイト環境で、サイトのURLを動的に取得する際に非常に便利です。以下に、この関数がよく使われる場面を示します。
- マルチサイトの特定サイトのURLを取得する場合
- プラグインでリダイレクトURLを生成する場合
- APIエンドポイントを構築する際のベースURLの取得
- カスタムリンクの作成時に利用する場合
- ショートコード内でサイトのURLを出力する場合
- テンプレートファイル内でサイトリンクを表示する場合
- オプションや設定ページのURLを取得する場合
- 自動生成されたメールや通知でURLを含める場合
構文
get_site_url( $blog_id = null, $path = '', $scheme = null );
パラメータ
$blog_id(int) – 取得するサイトのID（オプション, デフォルトは現在のサイト）。$path(string) – サイトURLの後に追加するパス（オプション）。$scheme(string) – URLのスキーム（’http’, ‘https’, ‘relative’, ‘link’ のいずれか；オプション）。
戻り値
- 取得したサイトのURL（文字列）。
関連する関数
使用可能なバージョン
- WordPress 3.0 以降
コアファイルのパス
wp-includes/ms.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 | 〇 |
サンプルコード
サンプルコード 1: 基本的な使用法
$site_url = get_site_url();
echo 'サイトURL: ' . $site_url;
このコードは、現在のサイトのURLを取得して表示します。
サンプルコード 2: 特定サイトのURL取得
$site_url = get_site_url( 2 );
echo 'サイト2のURL: ' . $site_url;
このコードは、IDが2のサイトのURLを取得して表示します。
サンプルコード 3: URLにパスを追加
$site_url = get_site_url( null, 'about' );
echo 'サイトのAboutページURL: ' . $site_url;
このコードは、現在のサイトの「about」ページのURLを取得して表示します。
サンプルコード 4: HTTPSスキームの使用
$secure_url = get_site_url(null, '', 'https');
echo '安全なサイトのURL: ' . $secure_url;
このコードは、HTTPSスキームを使用して現在のサイトのURLを取得して表示します。
サンプルコード 5: サイトURLをメールで使用
$site_url = get_site_url();
$message = '私たちのサイトにアクセスするには、次のリンクをクリックしてください: ' . $site_url;
wp_mail('user@example.com', 'サイトのご案内', $message);
このコードは、現在のサイトのURLを含むメールを送信します。