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



お勧め

WordPressと組み込まれている主なJavaScriptライブラリのバージョン一覧(2018年5月27日 更新)

WordPressの更新が遅れていたサイトを少し前に更新したところ、jQuery UI sortableを使って拡張したページに不具合が発生しました。WordPressの更新に伴って内部のjQuery UIが更新されたことに起因すると思われ、これを機にWordPressとそれに組み込まれたJavaScriptライブラリのバージョンを確認してみました。

ショートコードを使ってテーマ内の画像URLを簡単に指定する(2018年5月27日 更新)

投稿記事の中で画像パーツを使いたいときがある。画像パーツの配置場所は、/imgディレクトリのようなテーマ外の場合と、/wp-content/themes/mytheme/imagesディレクトリのようなテーマ内の場合があり、今回は後者のケース。ショートコードを使って投稿記事の画像ファイルのURLを記述する方法を紹介したい。

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

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

Login rebuilder 2.4.0の新機能を紹介(2018年5月27日 更新)

昨日、約半年ぶりにLogin rebuilderをアップデートし、著者ページ(author page)の閲覧を制限できる機能を追加した。この機能は、著者ページの閲覧によってユーザーIDが類推されることを防ぐことが目的としている。

ブロックエディターで編集したページが出力した余分な改行を削除(2019年2月22日 更新)

ブロックエディターで編集したページのHTMLソースは、投稿本文部分の改行が目立った。Webページとしての表示は問題ないのだが、データとしては不要なので削除することにした。