get_site_url() の使い方|説明・引数・注意点

説明

get_site_url() は、サイトURL(WordPress本体の場所)を返す関数です。マルチサイトでは、サイトIDを指定できます。

基本構文

get_site_url( int|null $blog_id = null, string $path = '', string|null $scheme = null ): string

引数

  • $blog_id:サイトID
  • $path:付け足すパス
  • $scheme:スキーム

戻り値

サイトURL。

使い方(サンプル)

echo esc_url( get_site_url() );

注意点

  • 通常のサイトでは site_url() で十分です。

実務での使いどころ

  • マルチサイトで、別のサイトのWordPress本体のURLを取得するとき($blog_id を指定)。
  • URLのスキームを指定して取得するとき。

よくあるミスと対処

  • 現在のサイトのURLでよいのに、この関数を使っている。現在のサイトなら site_url() で足りる。
  • トップページのURLが欲しいのに、これを使っている。トップページのURLは get_home_url()。

NG例

$url = get_site_url( 2, '/about/' ); // 固定ページのURLのつもり

OK例

$url = get_home_url( 2, '/about/' );
$login = get_site_url( 2, 'wp-login.php' );

使い分け早見表

関数 返すURL
get_site_url() 指定したサイトの、WordPress本体のURL
site_url() 現在のサイトの、WordPress本体のURL
get_home_url() 指定したサイトのトップページのURL

関連項目

site_url()、get_home_url()

公式リファレンス:get_site_url() | Function | WordPress Developer Resources

コメント

タイトルとURLをコピーしました