- 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細)
「テンプレートタグ/site url」の版間の差分
提供: WordPress Codex 日本語版
< テンプレートタグ
(ページ編集状態表示を「翻訳チェック待ち」に変更。) |
(最新版に更新、和訳。) |
||
1行目: | 1行目: | ||
− | |||
{{テンプレートタグガイド|PHP}} | {{テンプレートタグガイド|PHP}} | ||
== 説明<!-- Description --> == | == 説明<!-- Description --> == | ||
− | '''site_url()''' | + | '''site_url()''' テンプレートタグは、現在のブログのサイト URL (WordPress コアファイルが置かれている位置) を取得するために使います。取得する URL には [[関数リファレンス/is_ssl|is_ssl()]]/[[:en:Function Reference/is_ssl|en]] が有効の場合は 'https'、それ以外の場合は 'http' といった適切なプロトコルが含まれます。[[#Parameters|$scheme]] で 'http' か 'https' を指定すると、is_ssl()は無効になります。このテンプレートタグは、一般設定で指定した「WordPress アドレス」を取得するために使います。「サイトアドレス」を取得するには、[[関数リファレンス/home_url|home_url()]] を使ってください。 |
− | + | ||
− | + | WordPress ネットワークサイトを設定している場合は [[関数リファレンス/network_site_url|network_site_url()]] を使います。 | |
− | + | ||
− | == 使い方 | + | == 使い方 == |
− | <?php site_url( | + | <?php site_url( $path, $scheme ); ?> |
− | === デフォルトの使い方 | + | === デフォルトの使い方 === |
− | <?php site_url(); ?> | + | <?php echo site_url(); ?> |
− | == | + | == パラメータ == |
− | {{Parameter|path|string| | + | {{Parameter|$path|string|サイト URL に追加する相対パス。|省略可}} |
− | + | {{Parameter|$scheme|string|返される URL 用プロトコルのコンテクスト。$scheme を設定するとデフォルトのコンテクストが上書きされる。利用できる値は 'http'、'https'、'login'、'login_post'、'admin'、 | |
− | + | 'relative'。|省略可|null}} | |
− | + | ||
− | == 戻り値 | + | == 戻り値 == |
− | + | ; (string) : パスをオプションとして含む現在のサイト URL。 | |
− | + | ||
− | == 用例 | + | == 用例 == |
− | = | + | <pre> |
+ | $url = site_url(); | ||
+ | echo $url; | ||
+ | </pre> | ||
− | + | 出力: <code><nowiki>http://www.example.com</nowiki></code> または <code><nowiki>http://www.example.com/wordpress</nowiki></code> | |
− | < | + | |
− | + | (最後にスラッシュが含まれないことに注意) | |
− | < | + | <pre> |
− | < | + | $url = site_url('/secrets/', 'https'); |
+ | echo $url; | ||
+ | </pre> | ||
− | + | 出力: <code><nowiki>https://www.example.com/secrets/</nowiki></code> または <code><nowiki>https://www.example.com/wordpress/secrets/</nowiki></code> | |
− | |||
− | {{ | + | == 変更履歴 == |
+ | |||
+ | * [[Version 2.6|2.6.0]] 以降。 | ||
+ | |||
+ | == ソースファイル == | ||
+ | |||
+ | <code>site_url()</code> は {{Source|wp-includes/link-template.php}} にあります。 | ||
+ | |||
+ | == 関連 == | ||
+ | {{Directory URL Tags}} | ||
{{Tag Footer}} | {{Tag Footer}} | ||
+ | {{原文|Template Tags/site_url|140478}}<!-- 2014-01-14T18:25:43 Netweb 版 --> | ||
{{DEFAULTSORT:Site_url}} | {{DEFAULTSORT:Site_url}} | ||
[[Category:wp2.6]] | [[Category:wp2.6]] | ||
[[en:Template Tags/site_url]] | [[en:Template Tags/site_url]] |
2014年8月28日 (木) 10:17時点における最新版
タグ一覧: テンプレートタグ | インクルードタグ | 条件分岐タグ | その他の関数 | Code Reference
使い方: テンプレートタグ入門 | パラメータの渡し方 | 初心者の方へ | その他のテーマ関連資料
説明
site_url() テンプレートタグは、現在のブログのサイト URL (WordPress コアファイルが置かれている位置) を取得するために使います。取得する URL には is_ssl()/en が有効の場合は 'https'、それ以外の場合は 'http' といった適切なプロトコルが含まれます。$scheme で 'http' か 'https' を指定すると、is_ssl()は無効になります。このテンプレートタグは、一般設定で指定した「WordPress アドレス」を取得するために使います。「サイトアドレス」を取得するには、home_url() を使ってください。
WordPress ネットワークサイトを設定している場合は network_site_url() を使います。
使い方
<?php site_url( $path, $scheme ); ?>
デフォルトの使い方
<?php echo site_url(); ?>
パラメータ
- $path
- (string) (省略可) サイト URL に追加する相対パス。
- 初期値: なし
- $scheme
- (string) (省略可) 返される URL 用プロトコルのコンテクスト。$scheme を設定するとデフォルトのコンテクストが上書きされる。利用できる値は 'http'、'https'、'login'、'login_post'、'admin'、
'relative'。
- 初期値: null
戻り値
- (string)
- パスをオプションとして含む現在のサイト URL。
用例
$url = site_url(); echo $url;
出力: http://www.example.com
または http://www.example.com/wordpress
(最後にスラッシュが含まれないことに注意)
$url = site_url('/secrets/', 'https'); echo $url;
出力: https://www.example.com/secrets/
または https://www.example.com/wordpress/secrets/
変更履歴
- 2.6.0 以降。
ソースファイル
site_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 |
関数リファレンス、テンプレートタグ目次もご覧ください。