• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

「テンプレートタグ/home url」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(使い方の例に echo を追加 <?php echo home_url(); ?>)
 
(5人の利用者による、間の21版が非表示)
1行目: 1行目:
{{CheckTrans}}
+
== 説明<span id="Description"></span> ==
{{テンプレートタグガイド|PHP}}
+
  
== 説明 ==
+
'''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> による判定は無視されます。
<!-- == Description == -->
+
  
'''home_url''' テンプレートタグは、現在のブログのホームURLを返します。戻り値には 'home' [[Option Reference|オプション]] と適切なプロトコルが含まれます。 [[関数リファレンス/is_ssl|is_ssl()]]/[[:en:Function Reference/is_ssl|en]] が有効な場合は 'https'、それ以外の場合は 'http' です。[[#Parameters|scheme]] で 'http' か 'https' を指定すると、is_ssl() は無効になります。
+
WordPressで [[Create_A_Network|ネットワークの作成]] をしている場合は、代わりに [[テンプレートタグ/network_home_url|network_home_url()]] を使ってください。
<!-- The '''home_url''' template tag retrieves the home url for the current site. Returns the 'home' [[Option Reference|option]] with the appropriate protocol,  'https' if [[関数リファレンス/is_ssl|is_ssl()]]/[[:en:Function Reference/is_ssl|en]] and 'http' otherwise. If [[#Parameters|scheme]] is 'http' or 'https', is_ssl() is overridden. -->
+
  
任意のブログのホームURLを取得するには [[テンプレートタグ/get_home_url|get_home_url]] テンプレートタグを使います。
+
== 使い方<span id="Usage"></span> ==
<!-- Use the [[テンプレートタグ/get_home_url|get_home_url]] tag to retrieve the url of the site specified. -->
+
  
== 使い方 ==
+
<?php home_url( $path, $scheme ); ?>
<!-- == Usage == -->
+
  
<?php echo home_url( 'path', 'scheme' ); ?>
+
=== デフォルトの使い方<span id="Default_Usage"></span> ===
  
=== デフォルトの使い方 ===
+
<?php echo esc_url( home_url( '/' ) ); ?>
<!-- === Default Usage === -->
+
  
<?php echo home_url(); ?>
+
== パラメータ<span id="Parameters"></span> ==
  
== 引数<span id="Parameters"></span> ==
+
{{Parameter|$path|文字列|ホーム URL からの相対パス。|オプション}}
<!-- == Parameters <span id="Parameters"></span>== -->
+
{{Parameter|$scheme|文字列|ホーム URL に使うスキーム。現在利用できるのは <tt>"http"</tt> <tt>"https"</tt> と <tt>"relative"</tt>(相対パス)。|オプション|null}}
  
{{Parameter|path|string|ホームURLからの相対パス。|省略可}}
+
== 戻り値<span id="Return"></span> ==
{{Parameter|scheme|string|URLスキーム。現在利用できるのは 'http' と 'https'。|省略可|null}}
+
<!--
+
{{Parameter|path|string|Path relative to the home url.|optional}}
+
{{Parameter|scheme|string|Scheme to give the home url context. Currently 'http','https'.|optional|null}}
+
-->
+
  
== 戻り値 ==
+
; (文字列) : オプションの引数 $path の値を付加したホーム URL。
<!-- == Return == -->
+
  
(''string'') ホームURL(引数 path を指定した場合は、そのパスを含むURL)へのリンク。
+
== 用例<span id="Examples"></span> ==
<!-- (''string'') Home url link with optional path appended. -->
+
  
== 用例 ==
+
<pre>
<!-- == Examples == -->
+
$url = home_url();
 +
echo esc_url( $url );
 +
</pre>
  
== 変更履歴 ==
+
出力: http://www.example.com
<!-- == Changelog == -->
+
  
* [[Version 3.0|3.0.0]] : テンプレートタグとして新規追加。
+
(最後のスラッシュがないことに注意してください)
<!--
+
* [[Version 3.0|3.0.0]] : New template tag.
+
-->
+
  
== ソースコード ==
+
<pre>
<!-- == Source Code == -->
+
$url = home_url( '/' );
 +
echo esc_url( $url );
 +
</pre>
  
<code>home_url()</code> は、located in {{Source|wp-includes/link-template.php}} にあります。
+
出力: http://www.example.com/
<!-- <code>home_url()</code> is located in {{Source|wp-includes/link-template.php}} -->
+
  
{{Stub}}
+
<pre>
 +
$url = home_url( '/', 'https' );
 +
echo esc_url( $url );
 +
</pre>
  
{{原文|Function Reference/home url|91053}}<!-- 14:05, 5 July 2010 Bono 版 -->
+
出力: https://www.example.com/
  
== 関連項目 ==
+
<pre>
<!-- == Related == -->
+
$url = home_url( 'example', 'relative' );
 +
echo esc_url( $url );
 +
</pre>
  
{{Link Tags}}
+
出力: /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 );

出力: http://www.example.com

(最後のスラッシュがないことに注意してください)

$url = home_url( '/' );
echo esc_url( $url );

出力: http://www.example.com/

$url = home_url( '/', 'https' );
echo esc_url( $url );

出力: https://www.example.com/

$url = home_url( 'example', 'relative' );
echo esc_url( $url );

出力: /example

参考

変更履歴

  • 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最新版との差分