当サイト、Codex 日本語版は今後積極的な更新は行わない予定です。後継となる新ユーザーマニュアルは、https://ja.wordpress.org/support/ にあります。
万が一、当サイトで重大な問題を発見した際などは、フォーラムWordSlack #docs チャンネルでお知らせください。</p>

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

提供: WordPress Codex 日本語版
移動先: 案内検索
(en:Template Tags/get_home_url 14:02, 5 July 2010 Bono 版を翻訳用にコピー)
 
(誤記訂正)
 
(4人の利用者による、間の4版が非表示)
1行目: 1行目:
== Description ==
+
== 説明<span id="Description"></span> ==
  
The '''get_home_url''' template tag retrieves the home url for a given site. Returns the 'home' [[Option Reference|option]] with the appropriate protocol,  'https' if [[Function Reference/is_ssl|is_ssl()]] and 'http' otherwise. If [[#Parameters|scheme]] is 'http' or 'https', is_ssl() is overridden.
+
適切なプロトコルとともに <tt>'home'</tt> [[Option Reference|オプション]]を返します。プロトコルは [[関数リファレンス/is_ssl|is_ssl()]] が true なら <tt>'https'</tt>、それ以外の場合は <tt>'http'</tt> です。引数 <tt>$scheme</tt> が <tt>'http'</tt> または <tt>'https'</tt> の場合、is_ssl() による判定は上書きされます。
  
== Usage ==
+
== 使い方<span id="Usage"></span> ==
  
%%%<?php get_home_url( $blog_id, 'path', 'scheme' ); ?>%%%
+
<?php get_home_url( $blog_id, $path, $scheme ); ?>
  
=== Default Usage ===
+
=== デフォルトの使い方<span id="Default_Usage"></span> ===
  
%%%<?php get_home_url(); ?>%%%
+
<?php echo esc_url( get_home_url() ); ?>
  
== Parameters ==
+
== パラメータ ==
  
{{Parameter|blog_id|integer|Blog ID.|optional|null (the current blog)}}
+
{{Parameter|$blog_id|整数|ブログ ID。|オプション|null (現在のブログ)}}
{{Parameter|path|string|Path relative to the home url.|optional}}
+
{{Parameter|$path|文字列|ホーム URL への相対パス。|オプション}}
{{Parameter|scheme|string|Scheme to give the home url context. Currently 'http','https'.|optional|null}}
+
{{Parameter|$scheme|文字列|ホーム URL にコンテキストを与えるスキーマ。現在利用できるのは <tt>'http'</tt>, <tt>'https'</tt>, <tt>'relative'</tt> (相対パス), および <tt>'rest'</tt>。|オプション|null}}
  
== Return ==
+
== 戻り値<span id="Return"></span> ==
  
(''string'') Home url link with optional path appended.
+
; (文字列) : オプションのパス ($path) を追加したホーム URL リンク。
  
== Hooks ==
+
== 用例<span id="Examples"></span> ==
  
[[Function Reference/apply_filters|apply_filters()]] Calls 'home_url' hook on home url before returning.
+
== 参考<span id="Notes"></span> ==
  
== Examples ==
+
値を返す前に、[[関数リファレンス/apply_filters|apply_filters()]] を使ってホーム URL へ 'home_url' フィルターを適用します。
  
== Changelog ==
+
== 変更履歴<span id="Changelog"></span> ==
  
* [[Version 3.0|3.0.0]] : New template tag.
+
* [[Version 3.0|3.0.0]] : 新規導入。
  
== Source Code ==
+
== ソースファイル<span id="Source_Code"></span> ==
  
<code>get_home_url()</code> is located in
+
<code>get_home_url()</code> {{Trac|wp-includes/link-template.php}} にあります。
* {{Source|wp-includes/link-template.php}} ({{CurrentVersion}})
+
* {{Source|wp-includes/link-template.php|trunk}} (the development version)
+
  
{{Stub}}
+
== 関連項目<span id="Related"></span> ==
  
{{原文|Template Tags/get_home_url|91052}}<!-- 14:02, 5 July 2010 Bono 版 -->
+
{{Edit Link Tags}}
 +
{{Tag Footer}}
  
== Related ==
+
{{原文|Function Reference/get_home_url|140475}} <!-- 2014-01-14T18:05:39 Netweb 版 -->
 
+
{{Link Tags}}
+
 
+
{{Tag Footer}}
+
  
[[Category:Template Tags]]
+
{{DEFAULTSORT:Get_home_url}}
[[Category:New page created]]
+
[[Category:テンプレートタグ]]
 +
[[Category:wp3.0]]
  
 
[[en:Template Tags/get_home_url]]
 
[[en:Template Tags/get_home_url]]

2018年3月3日 (土) 21:03時点における最新版

説明

適切なプロトコルとともに 'home' オプションを返します。プロトコルは is_ssl() が true なら 'https'、それ以外の場合は 'http' です。引数 $scheme'http' または 'https' の場合、is_ssl() による判定は上書きされます。

使い方

<?php get_home_url( $blog_id, $path, $scheme ); ?>

デフォルトの使い方

<?php echo esc_url( get_home_url() ); ?>

パラメータ

$blog_id
整数) (オプション) ブログ ID。
初期値: null (現在のブログ)
$path
文字列) (オプション) ホーム URL への相対パス。
初期値: なし
$scheme
文字列) (オプション) ホーム URL にコンテキストを与えるスキーマ。現在利用できるのは 'http', 'https', 'relative' (相対パス), および 'rest'
初期値: null

戻り値

(文字列) 
オプションのパス ($path) を追加したホーム URL リンク。

用例

参考

値を返す前に、apply_filters() を使ってホーム URL へ 'home_url' フィルターを適用します。

変更履歴

  • 3.0.0 : 新規導入。

ソースファイル

get_home_url()wp-includes/link-template.php にあります。

関連項目

リンク編集 edit_post_link, edit_comment_link, edit_tag_link, edit_bookmark_link /en


関数リファレンステンプレートタグ目次もご覧ください。


最新英語版: WordPress Codex » Function Reference/get_home_url最新版との差分