set_url_scheme

説明

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に'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

最終更新 : 2018年05月27日 10:44



お勧め

管理画面でツールバー(Admin bar)を非表示にする(2013年3月5日 更新)

WordPress使ってちょっと変わったサイトを構築する際、管理画面のツールバーを表示させたくないケースがある。一般に公開するサイト側であれば、 show_admin_bar関数で非表示にできるのだが、管理画面ではこれを使ってもツールバーは消えてくれない。

サイドバーの初期化はwidgets_initアクションで(2011年7月14日 更新)

ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。

タイトルが一致する投稿を検索する(2014年2月20日 更新)

WordPressが提供する投稿ページの文字列検索機能の実現には、 query_posts関数(WP_Queryクラス)が大きな役割を担っている。ここで紹介するのは、高機能ゆえに使いこなすのが難しいquery_posts関数(WP_Queryクラス)の使用法の一例である。

投稿ページでユニークなテンプレートを選択しよう(2018年5月27日 更新)

4.7の変更点に「投稿タイプテンプレート」がある。これは従来固定ページ('page')向けに任意のテンプレートを適用できる機能が拡張されたもので、投稿ページ('post')はもちろんカスタム投稿タイプのページにも適用可能になっている。

WordPressの鼓動(2013年10月1日 更新)

WordPressでは、Ajaxを利用する方法の1つとして add_action関数を利用することができる。この方法を調べている過程で、'heartbeat'というおもしろそうなAjaxアクションがあったので、紹介しておく。