開発ブログ

WWWクリエイターズが送る、Git、CSS、HTML、コマンドライン、Macの便利機能など、開発に関する役立ち情報発信します。気まぐれに更新。

home_url() とget_home_url()を理解する。

最終更新:2017-12-07 by Joe

WordPressでホームURLを取得する関数、get_home_url()。よく似た名前のhome_url()という関数との違いが曖昧になりがちなので、仕様と用法をまとめました。

ホームのURLを出力する方法

ホームURLを取得する関数は、「home_url()」です。この関数は、名前からはあたかも出力をしてくれそうな印象を受けますが、実際は文字列を返却するだけです。

実際に出力する場合は、返された文字列をecho すればよいわけですが、HTMLタグの属性内に文字列を出力する場合、不正な文字列をエスケープするのが鉄則です。そのためにWordPress関数「esc_url()」をかぶせるのが常套手段です。

// HTMLタグ属性値に対して、ホームのURLを出力する
echo esc_url( home_url() );

また、home_url() は第一引数にパスを受け付けますので、「/example-page」などの固定ページURLを出力表示したい時は、下記のように引数で渡す記述が一般的です。

// example-page のURLを出力する
echo esc_url( home_url( 'example-page' ) );

esc_url() は必要?

ホームURLにかぎらず、例えば、なんらかの理由で「”」がどこかのURL文字列内に入り込んだ事を考えてみて下さい。

<a href="http://www-"creators.com/contacct">お問い合わせ</a>

ドキュメントが容易に崩壊する事は容易に想像できると思います。これ以外にも不正な文字をすべてエスケープしてくれます。esc_url() は安全なWordPressサイト構築に必要な関数です。

home_url() とget_home_url()

WordPressにおける「ホームのURL」とは、「ウェブサイトのトップページとして位置づけられているページのURL」このホームのURLは、最下層ではデータベースの「options」テーブルに格納された「home」というフィールドとして知られています。home_url() は、まさしくこれを取得するための関数です。ソースコード(wp-includes/link-template.php)を見てみます。

home_url() のソースコード

function home_url( $path = '', $scheme = null ) {
    return get_home_url( null, $path, $scheme );
}

get_home_url() を簡素にラップした関数となっている事がわかります。続いて、get_home_url() のコードを確認します。

get_home_url()  のソースコード

function get_home_url( $blog_id = null, $path = '', $scheme = null ) {
    global $pagenow;
 
    $orig_scheme = $scheme;
 
    if ( empty( $blog_id ) || !is_multisite() ) {
        $url = get_option( 'home' );
    } else {
        switch_to_blog( $blog_id );
        $url = get_option( 'home' );
        restore_current_blog();
    }
 
    if ( ! in_array( $scheme, array( 'http', 'https', 'relative' ) ) ) {
        if ( is_ssl() && ! is_admin() && 'wp-login.php' !== $pagenow )
            $scheme = 'https';
        else
            $scheme = parse_url( $url, PHP_URL_SCHEME );
    }
 
    $url = set_url_scheme( $url, $scheme );
 
    if ( $path && is_string( $path ) )
        $url .= '/' . ltrim( $path, '/' );
 
    /**
     * Filters the home URL.
     *
     * @since 3.0.0
     *
     * @param string      $url         The complete home URL including scheme and path.
     * @param string      $path        Path relative to the home URL. Blank string if no path is specified.
     * @param string|null $orig_scheme Scheme to give the home URL context. Accepts 'http', 'https',
     *                                 'relative', 'rest', or null.
     * @param int|null    $blog_id     Site ID, or null for the current site.
     */
    return apply_filters( 'home_url', $url, $path, $orig_scheme, $blog_id );
}

home_url() と比べると、$blog_id という第一引数が追加されています。これは、WordPressのマルチサイト機能におけるサイトの識別子です。多くの場合はシングルサイトで開発しているはずですので、そこまでこの引数を意識することは無いでしょう。

もし、blog_id がnullで指定されれば(nullは、引数の初期値です。)、optionsテーブルの値を取得する、get_option() 関数で単純にhomeの値を参照している事がわかります。

そのほか、プロトコルであるHTTP, HTTPS の識別(WordPressは、自動でリダイレクトにより、URLを片方に正規化しています。)や、第二引数$pathで、スラッシュ有り無しを正規化しています。「あれ?スラッシュ必要だっけ?」と悩む必要がない親切設計です。

各種URLの出力関数

ちなみに、wp-includes/link-template.php には、home_url() のような種々のURL文字列の取得関数が記述されています。いずれも同じような命名規則となっています。こちらで定義されているようなURL値はすべて関数を通して出力すべきでしょう。

例:

  • home_url():ホームのURLを返す
  • site_url() - ワードプレスのルートディレクトリを指すURLを返す
  • admin_url():管理画面のURLを返す

site_url() と home_url()

上記の wp-includes/link-template.php 関数に、でsite_url() という関数があります。site_url() と home_url() は名前はよく似ていますが、これらはそれぞれ、options テーブルの「siteurl」と「home」に対応刷る関数で、しばしば混同されます。

それぞれ、正式に異なる意味を持った値です。

  • home: サイトのホームページのURL
  • siteurl: ワードプレスルートを指すURL

例えば「wp-config.php」が配置されたディレクトリが「siteurl」です。WordPress設置方法によっては、このようなケースもあるでしょう。

  • home: http://example.com
  • siteurl: http://example.com/wp

管理画面>設定>一般設定でも2つのフィールドが用意されています。

参考

公式ドキュメントです。

 

閉じる