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

説明

site_url() は、WordPress本体がインストールされているURL(サイトURL)を返す関数です。

基本構文

site_url( string $path = '', string|null $scheme = null ): string

引数

  • $path:付け足すパス
  • $scheme:スキーム

戻り値

サイトURLの文字列。

使い方(サンプル)

echo esc_url( site_url( '/wp-login.php' ) );

注意点

  • WordPressをサブディレクトリにインストールしている場合、home_url() と値が異なります。
  • ログインURLなど、WordPress本体に関係するURLに使います。

実務での使いどころ

  • wp-login.php など、WordPress本体のファイルのURLを作るとき。
  • WordPressを、サブディレクトリに置いたサイトで、本体の場所を指定するとき。

よくあるミスと対処

  • サイトのトップページのURLが欲しいのに、これを使っている。トップページのURLは home_url()。
  • 出力するときに、esc_url() を通していない。

NG例

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

OK例

$url = home_url( '/about/' );
$login = site_url( 'wp-login.php' );

使い分け早見表

関数 返すURL
site_url() WordPress本体が置かれたURL
home_url() サイトのトップページのURL
admin_url() 管理画面のURL

関連項目

home_url()、admin_url()

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

コメント

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