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はスキーマ部を省略した'//'から開まるものも指定できる。

パラメータ$schemenullの場合は、 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

最終更新 : 2019年11月22日 13:08



お勧め

6.2に追加されるsearch_columnsパラメータが便利(2023年3月30日 更新)

バージョン6.2では記事検索機能を備えたWP_Queryクラスにsearch_columnsパラメータが追加される。標準のキーワード検索では、タイトル(post_title)、本文(post_content)、抜粋(post_excerpt)が対象になっているが、search_columnsパラメータを使うと対象を絞り込めるようになる。

固定ページのURLの拡張子をhtmlに変更する(2013年3月9日 更新)

固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。

KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)

本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。

Fotepo:プラグイン作ってみました(2019年9月19日 更新)

仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。

カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。