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

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



お勧め

4.2.3でちょっと変わったショートコード(2018年5月27日 更新)

4.3のリリースまであと少しなわけですが、4.2.3が緊急リリースされました。4.2.2とソースコードを比較すると、ざっくりTinyMCE絡みが多い印象を受けたのですが、ショートコード関連も少し変わっていたので簡単にまとめてみました。

タイトルのみをキーワード検索する(2014年4月3日 更新)

WordPressのキーワード検索は、投稿タイトルと本文のどちらかに指定したキーワードが含まれているかを調べるわけだが、時々タイトルだけとか、逆に本文だけ検索したいケースがある。

プラグインのヘッダー情報を国際化対応しよう(2018年5月27日 更新)

バージョン4.8がリリースされてひと段落。あらためてプラグイン一覧ページを見てみると「Akismet」が「Akismet Anti-Spam (アンチスパム)」と表示されていた。説明文だけじゃなくプラグイン名も国際化対応できたのね。

Gutenbergエディターのフォントを変える(2018年10月16日 更新)

Gutenbergエディターを試していてしっくりこないのが、編集時とそれを投稿した際の見た目の違い。GutenbergエディターとテーマTwenty Seventeenとではまったく異なるタイプのフォントが適用されていることが大きな理由である。

Contact Form 7に確認フェーズを(2012年12月16日 更新)

Contact Form 7はWordPressによるサイト製作でお世話になることが多いプラグインの1つ。ただ、クライアント様によっては、入力、確認、送信の3フェーズにしたいという要望があり、そんな時は別の方法を採用していたのですが、JavaScript(jQuery)を使ってページ遷移しなくてもいいなら確認フェーズは用意できるかなと思い、作り込んでみた。