set_url_scheme:WordPress私的マニュアル

set_url_scheme

(3.4.0以降)
set_url_scheme - URLにスキーマをセットする

説明

string set_url_scheme( string $url, string $scheme = null )

URLに適正なスキーマをセットする。

パラメータ

$url
URLを指定。
$scheme
スキーマとして'http'、'https'、'login'、'login_post'、'admin'、'relative'、'rest'、'rpc'の何れかを指定（省略時はnull）。

返り値

適正なスキーマをセットしたURLを返す。

注意

パラメータ$urlはスキーマ部を省略した'//'から開まるものも指定できる。

パラメータ$schemeがnullの場合は、is_ssl関数がtrueの場合は'https'が、falseの場合は'http'が適用される。
パラメータ$schemeが'admin'、'login'、'login_post'、'rpc'の何れかの場合は、is_sslかforce_ssl_admin関数のどちらかがtrueの場合に'https'が、どちらもfalseの場合は'http'が適用される。
パラメータ$schemeが上記以外でかつ'http'、'https'、'relative'の何れでもない場合もis_ssl関数の結果に応じて'https'または'http'が適用される。

[4.4.0]パラメータ$schemeに'rest'が追加された。

使用例

URLにスキーマをセットする。
$url = set_url_scheme( $url ); ?>
URLに'admin'向けのスキーマをセットする。
$url = set_url_scheme( $url, 'admin' ); ?>

フィルター

[3.4.0]スキーマをセットしたURLを返す前に'set_url_scheme'フィルターを呼び出す。パラメータ$urlはスキーマをセットしたURLが、$schemeには'https'、'http'、'relative'の何れかが、$orig_schemeには本関数が受け取った$schemeの値が格納される。

return apply_filters( 'set_url_scheme', $url, $scheme, $orig_scheme );

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/link-tenplate.php

参考

Code Reference: set_url_scheme

set_url_scheme

説明

パラメータ

返り値

注意

使用例

フィルター

アクション

ソースファイル

関連

参考

お勧めコンテンツ