開発ブログ
Git、CSS、HTML、正規表現など、入門者がつまづきそうなポイントを中心に、役立ち情報発信します。。

WordPressトップURLの取得: home_url() と get_home_url() の違い

最終更新:2018-07-11 by Joe

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

WordPress ホーム(トップページ)のURLを取得する home_url()

通常のテーマやプラグイン開発において、トップページURLを取得する関数は、ズバリ「home_url()」です。

この関数は、名前からはあたかも文字列を出力をしてくれそうな印象を受けますが、実際は文字列を返却するだけです。(命名規則の混乱はおそらく歴史的な理由によるものだと思われます)

後ほど触れますが、サイトがWordPressの「マルチサイト機能」を使ったマルチサイトでない限りは、トップページのURL文字列の取得には get_home_url() でなく、home_url() を使うと良いでしょう。

実際に出力する場合は、返された文字列をecho すればよいわけです。

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

<a href="<?php echo home_url( 'whats-home' ); ?>">ホームとは?</a>

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

URL最初のスラッシュは関数内で無効化(trim関数で削除される)されますので、あってもなくてもどちらでも構いません。

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

不安な人はこの記事の下のほうに関数のソースコードを貼ったので、ご確認下さい。

esc_url() でエスケープする

home_url() 関数に限らない一般的な問題なのですが、例えば、なんらかの理由で「”」がどこかのURL文字列内に入り込んだ事を考えてみて下さい。

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

href 属性内に出現する文字「”」により、HTMLドキュメントが崩壊してしまう事は容易に想像できると思います。

このように、不正な文字列を出力してしまう恐れがあるケースでは「esc_url()」を利用して、危険な文字をエスケープします。この関数は安全なWordPressサイト構築に必須な関数です。

<a href="<?php echo esc_url( home_url('「"」があっても大丈夫') ); ?>">
  エスケープの極意
</a>

home_url() はデータベース(options テーブルの home の値です)内の文字列を出力する関数です。テーマの実際のユーザーがどのような値をデータベースに入力するかは、テーマ開発者はコントロールできないため、危険文字が入り込んでくる可能性を消すことができません。

このような、第三者によって変更される任意の文字列を、HTMLのテキスト領域以外に出力しなければいけないケース(配布用テーマ開発においては、よく発生します。)では、出力文字列にWordPress関数「esc_url()」をかぶせるのが常套手段です。

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 );
}

home_url() は、get_home_url() を簡素にラップした関数となっている事がわかります。続いて、get_home_url() のコードを確認します。引数に$blog_id なる、ブログIDを受け付けます。

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: WordPress のコアコードが配置されたディレクトリを指すURL

コアコードとは、CMS自体のシステムコードのことで、例えば「wp-config.php」が配置されたディレクトリが「siteurl」となります。これは必ずしもトップページのURLと一致しないため、別々の設定値になっています。例えば、WordPress の設置方法によっては、下記のようなケースもあるでしょう。

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

このような場合は、.htaccess と index.php に特別な設定が必要ですので、公式ドキュメントサイトにも言及がああります。

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

【参考】テーマのルートURLを取得:get_theme_file_uri()

少し用途が異なりますが、WordPress 4.7 からget_theme_file_uri() なる関数が追加されました。これは、「WordPress テーマファイルのルート」を取得する関数です。

すなわち、テーマ内の 「image/common/logo.png」を指すURIを取得したければ、

<img src="<?php echo get_theme_file_uri( 'image/commmon/logo.png' ); ?>">

この関数のコードをみてみます。

コード自体は簡素で、テーマの親子関係を吸収するように設計されています、

function get_theme_file_uri( $file = '' ) {
    $file = ltrim( $file, '/' );
 
    if ( empty( $file ) ) {
        $url = get_stylesheet_directory_uri();
    } elseif ( file_exists( get_stylesheet_directory() . '/' . $file ) ) {
        $url = get_stylesheet_directory_uri() . '/' . $file;
    } else {
        $url = get_template_directory_uri() . '/' . $file;
    }

get_stylesheet_directory_uri()、 get_template_directory_uri() は、親子テーマでなければ、同じURIを出力しますが、現在のコードが子テーマであれば、それぞれ子テーマ、親テーマのルートを指し示します。

参考

公式ドキュメントです。

こちらは日本語ないですが

 

以上です。

閉じる