set_url_scheme │ filter-hook │ WP 3.4.0

Filters the resulting URL after setting the scheme.

Usage

add_filter( 'set_url_scheme', 'wp_kama_set_url_scheme_filter', 10, 3 );

/**
 * Function for `set_url_scheme` filter-hook.
 * 
 * @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 string
 */
function wp_kama_set_url_scheme_filter( $url, $scheme, $orig_scheme ){

	// filter...
	return $url;
}

$url(string)

The complete URL including scheme and path.

$scheme(string)

Scheme applied to the URL. One of 'http', 'https', or 'relative'.

$orig_scheme(string|null)

Scheme requested for the URL. One of 'http', 'https', 'login', 'login_post', 'admin', 'relative', 'rest', 'rpc', or null.

Changelog

Where the hook is called

return apply_filters( 'set_url_scheme', $url, $scheme, $orig_scheme );

Where the hook is used in WordPress