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

関連

参考

Code Reference: set_url_scheme

お勧め

任意の名前でエラーログファイルを指定する（2019年2月15日 更新）

来週にはWordPress 5.1がリリース。RC1のソースコードを見ていると、 wp_debug_mode関数が変更されており、興味深かった。

Gutenbergでカスタムフィールドを使う（2018年8月10日 更新）

Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。

Slightly troublesome permalink：プラグイン作ってみました（2021年4月20日 更新）

カテゴリーを含んだパーマリンクを設定している場合、複数のカテゴリーを指定した投稿記事のパーマリンクのURLに目的のカテゴリーとは異なるカテゴリーが適用された経験はないだろうか。このプラグインは、パーマリンクに適用されるカテゴリーをコントロールし、希望通りのパーマリンクを設定します。

WP_Postオブジェクトで投稿情報を直感的に使う（2012年10月4日 更新）

WordPress 3.5で登場するであろう WP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。

テキストエディタの文字を変更する（2018年5月27日 更新）

テキストエディタ（投稿ページの「テキスト」タブのエディタ）に標準では備わっていない機能を追加する自作プラグイン「html entities button」がほぼ1年ぶりにアップデート。ここではバージョン2.0.0で追加したテキストエディタのフォント切り替え機能について紹介する。