- 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細)
「テンプレートタグ/home url」の版間の差分
提供: WordPress Codex 日本語版
< テンプレートタグ
細 (日本語版向けに調整/要翻訳) |
細 |
||
(7人の利用者による、間の23版が非表示) | |||
1行目: | 1行目: | ||
− | + | == 説明<span id="Description"></span> == | |
− | + | ||
− | + | '''home_url''' テンプレートタグは、現在のブログのホーム URL を返します。オプションで引数 <tt>$path</tt> の内容を付加して返すこともできます。この関数は適切なプロトコルを判定します。[[関数リファレンス/is_ssl|is_ssl()]] /[[:en:Function Reference/is_ssl|en]] が有効な場合は <tt>"https"</tt>、それ以外の場合は <tt>"http"</tt> です。引数 <tt>$scheme</tt> で <tt>"http"</tt> か <tt>"https"</tt> を指定すると、<tt>is_ssl()</tt> による判定は無視されます。 | |
− | + | WordPressで [[Create_A_Network|ネットワークの作成]] をしている場合は、代わりに [[テンプレートタグ/network_home_url|network_home_url()]] を使ってください。 | |
− | + | == 使い方<span id="Usage"></span> == | |
− | + | <?php home_url( $path, $scheme ); ?> | |
− | + | === デフォルトの使い方<span id="Default_Usage"></span> === | |
− | + | <?php echo esc_url( home_url( '/' ) ); ?> | |
− | + | == パラメータ<span id="Parameters"></span> == | |
− | + | {{Parameter|$path|文字列|ホーム URL からの相対パス。|オプション}} | |
+ | {{Parameter|$scheme|文字列|ホーム URL に使うスキーム。現在利用できるのは <tt>"http"</tt> と <tt>"https"</tt> と <tt>"relative"</tt>(相対パス)。|オプション|null}} | ||
− | + | == 戻り値<span id="Return"></span> == | |
− | + | ||
− | + | ; (文字列) : オプションの引数 $path の値を付加したホーム URL。 | |
− | + | == 用例<span id="Examples"></span> == | |
− | = | + | <pre> |
+ | $url = home_url(); | ||
+ | echo esc_url( $url ); | ||
+ | </pre> | ||
− | + | 出力: http://www.example.com | |
− | + | (最後のスラッシュがないことに注意してください) | |
− | = | + | <pre> |
+ | $url = home_url( '/' ); | ||
+ | echo esc_url( $url ); | ||
+ | </pre> | ||
− | + | 出力: http://www.example.com/ | |
− | + | <pre> | |
+ | $url = home_url( '/', 'https' ); | ||
+ | echo esc_url( $url ); | ||
+ | </pre> | ||
− | + | 出力: https://www.example.com/ | |
− | = | + | <pre> |
+ | $url = home_url( 'example', 'relative' ); | ||
+ | echo esc_url( $url ); | ||
+ | </pre> | ||
− | + | 出力: /example | |
+ | == 参考<span id="Notes"></span> == | ||
+ | |||
+ | * [[テンプレートタグ/get_home_url | get_home_url()]] を使用。 | ||
+ | * [[Option Reference|オプション]] の <tt>'home'</tt> を使用。 | ||
+ | |||
+ | == 変更履歴<span id="Changelog"></span> == | ||
+ | |||
+ | * [[Version 3.0|3.0.0]] : 新規導入。 | ||
+ | |||
+ | == ソースファイル<span id="Source_Code"></span> == | ||
+ | |||
+ | <code>home_url()</code> は {{Trac|wp-includes/link-template.php}} にあります。 | ||
+ | |||
+ | == 関連項目<span id="Related"></span> == | ||
+ | |||
+ | {{Directory URL Tags}} | ||
{{Tag Footer}} | {{Tag Footer}} | ||
+ | |||
+ | {{原文|Function Reference/home url|155959}} <!-- 13:33, 8 March 2016 BrianLayman 版 --> | ||
{{DEFAULTSORT:Home_url}} | {{DEFAULTSORT:Home_url}} | ||
+ | [[Category:テンプレートタグ]] | ||
+ | [[Category:関数]] | ||
+ | |||
[[Category:wp3.0]] | [[Category:wp3.0]] | ||
[[en:Template Tags/home_url]] | [[en:Template Tags/home_url]] |
2018年3月2日 (金) 21:28時点における最新版
説明
home_url テンプレートタグは、現在のブログのホーム URL を返します。オプションで引数 $path の内容を付加して返すこともできます。この関数は適切なプロトコルを判定します。is_ssl() /en が有効な場合は "https"、それ以外の場合は "http" です。引数 $scheme で "http" か "https" を指定すると、is_ssl() による判定は無視されます。
WordPressで ネットワークの作成 をしている場合は、代わりに network_home_url() を使ってください。
使い方
<?php home_url( $path, $scheme ); ?>
デフォルトの使い方
<?php echo esc_url( home_url( '/' ) ); ?>
パラメータ
- $path
- (文字列) (オプション) ホーム URL からの相対パス。
- 初期値: なし
- $scheme
- (文字列) (オプション) ホーム URL に使うスキーム。現在利用できるのは "http" と "https" と "relative"(相対パス)。
- 初期値: null
戻り値
- (文字列)
- オプションの引数 $path の値を付加したホーム URL。
用例
$url = home_url(); echo esc_url( $url );
(最後のスラッシュがないことに注意してください)
$url = home_url( '/' ); echo esc_url( $url );
$url = home_url( '/', 'https' ); echo esc_url( $url );
$url = home_url( 'example', 'relative' ); echo esc_url( $url );
出力: /example
参考
- get_home_url() を使用。
- オプション の 'home' を使用。
変更履歴
- 3.0.0 : 新規導入。
ソースファイル
home_url()
は wp-includes/link-template.php
にあります。
関連項目
WordPress ディレクトリ: | ||
home_url() | ホーム URL | http://www.example.com |
site_url() | サイトディレクトリ URL | http://www.example.com または http://www.example.com/wordpress |
admin_url() | 管理画面ディレクトリ URL | http://www.example.com/wp-admin |
includes_url() /en | インクルードディレクトリ URL | http://www.example.com/wp-includes |
content_url() /en | コンテンツディレクトリ URL | http://www.example.com/wp-content |
plugins_url() /en | プラグインディレクトリ URL | http://www.example.com/wp-content/plugins |
wp_upload_dir() /en | アップロードディレクトリ URL (配列を返す) | http://www.example.com/wp-content/uploads |
関数リファレンス、テンプレートタグ目次もご覧ください。
最新英語版: WordPress Codex » Function Reference/home url (最新版との差分)