set_url_scheme() │ WP 3.4.0

Устанавливает протокол для указного URL (ссылки). Если в $scheme указать relative, то получит относительную ссылку.

Функция НЕ добавляет схему к пустому URL. Если указать так: example.org/what/ever, то функция не поймет что это URL и не обработает такую строку (вернет её как есть). По этой причине у исходного URL всегда должна быть базовая схема, например, https://.

$url = 'example.org/what/ever/';
echo set_url_scheme( $url, 'https' ); // example.org/what/ever
Работает на основе: is_ssl(), force_ssl_admin()
1 раз — 0.000017 сек (очень быстро) | 50000 раз — 0.07 сек (скорость света) | PHP 7.0.2, WP 4.4.1
Хуки из функции

Возвращает

Строку. Измененный URL под выбранную схему.

Использование

set_url_scheme( $url, $scheme );
$url(строка) (обязательный)
URL содержащий протокол http(s).
$scheme(строка/null)

Схема в соответствии с которой нужно изменять URL. Может быть:

http
https
relative    — вернет относительный URL (без домена).
login       — протокол страницы авторизации
login_post
admin
rest
rpc
null        — текущий протокол сайта is_ssl()

По умолчанию: null (текущий протокол сайта is_ssl())

Примеры

0

#1 Демонстрация изменения протокола в URL.

Код выполнялся на сайте с HTTPS протоколом по дефолту:

$res = [
	set_url_scheme( 'http://example.com/foo' ),             //> https://example.com/foo
	set_url_scheme( 'http://example.com/foo', 'http' ),     //> http://example.com/foo
	set_url_scheme( 'http://example.com/foo', 'https' ),    //> https://example.com/foo
	set_url_scheme( 'http://example.com/foo', 'relative' ), //> /foo

	set_url_scheme( '//example.com/foo' ),               //> https://example.com/foo
	set_url_scheme( '//example.com/foo', 'http' ),       //> http://example.com/foo
	set_url_scheme( '//example.com/foo', 'https' ),      //> https://example.com/foo
	set_url_scheme( '//example.com/foo', 'relative' ),   //> /foo

	// Не работает если это не URL
	set_url_scheme( '/foo', 'https' ),               //> /foo
	set_url_scheme( 'example.com/foo', 'https' ),    //> example.com/foo

	// Исключения
	set_url_scheme( '///example.org/foo', 'https' ), //> https:///example.org/foo
];

print_r( $res );

Список изменений

С версии 3.4.0 Введена.
С версии 4.4.0 The 'rest' scheme was added.

Код set_url_scheme() WP 6.1.1

wp-includes/link-template.php 
function set_url_scheme( $url, $scheme = null ) {
	$orig_scheme = $scheme;

	if ( ! $scheme ) {
		$scheme = is_ssl() ? 'https' : 'http';
	} elseif ( 'admin' === $scheme || 'login' === $scheme || 'login_post' === $scheme || 'rpc' === $scheme ) {
		$scheme = is_ssl() || force_ssl_admin() ? 'https' : 'http';
	} elseif ( 'http' !== $scheme && 'https' !== $scheme && 'relative' !== $scheme ) {
		$scheme = is_ssl() ? 'https' : 'http';
	}

	$url = trim( $url );
	if ( substr( $url, 0, 2 ) === '//' ) {
		$url = 'http:' . $url;
	}

	if ( 'relative' === $scheme ) {
		$url = ltrim( preg_replace( '#^\w+://[^/]*#', '', $url ) );
		if ( '' !== $url && '/' === $url[0] ) {
			$url = '/' . ltrim( $url, "/ \t\n\r\0\x0B" );
		}
	} else {
		$url = preg_replace( '#^\w+://#', $scheme . '://', $url );
	}

	/**
	 * Filters the resulting URL after setting the scheme.
	 *
	 * @since 3.4.0
	 *
	 * @param string      $url         The complete URL including scheme and path.
	 * @param string      $scheme      Scheme applied to the URL. One of 'http', 'https', or 'relative'.
	 * @param string|null $orig_scheme Scheme requested for the URL. One of 'http', 'https', 'login',
	 *                                 'login_post', 'admin', 'relative', 'rest', 'rpc', or null.
	 */
	return apply_filters( 'set_url_scheme', $url, $scheme, $orig_scheme );
}

ssl

Форматирование