get_home_url()


WordPressのget_home_url()関数は、サイトのホームURLを取得するために使用されます。この関数は、サイトのルートURLを返すため、カスタムリンクやリダイレクトの設定に役立ちます。

構文

get_home_url( int $blog_id = null, string $path = '', string $scheme = null );

引数の説明:

  • $blog_id(int) — マルチサイト環境で使用されるブログID。単一サイトの場合は省略可能。
  • $path(string) — ホームURLに追加するパス。
  • $scheme(string) — URLスキーム（例: ‘http’, ‘https’, ‘relative’）。

例1: 基本的なホームURLの取得

この例では、サイトのホームURLを取得します。

<?php echo get_home_url(); ?>

例2: カスタムパスを追加したホームURLの取得

ホームURLに特定のパスを追加します。

<?php echo get_home_url( null, 'custom-path' ); ?>

例3: HTTPSスキームを使用したホームURLの取得

HTTPSスキームを使用してホームURLを取得します。

<?php echo get_home_url( null, '', 'https' ); ?>

例4: マルチサイト環境での特定のサイトのホームURLを取得

マルチサイト環境で、特定のサイトのホームURLを取得します。

<?php echo get_home_url( 2 ); ?>

例5: ホームURLをリンクとして表示

ホームURLをリンクとして表示します。

<?php echo '<a href="' . get_home_url() . '">ホームへ戻る</a>'; ?>

例6: ホームURLをリダイレクト先として使用

ユーザーをホームページにリダイレクトします。

<?php wp_redirect( get_home_url() ); exit; ?>

例7: ホームURLをJavaScriptで使用

JavaScriptでホームURLを使用します。

<script>var homeUrl = "<?php echo get_home_url(); ?>";</script>

注意点

  • マルチサイト環境では、$blog_idを正しく指定する必要があります。
  • スキームを指定する場合、サイトがそのスキームをサポートしているか確認してください。
  • リダイレクトを使用する際は、exitを忘れないでください。

関連機能：