set_url_scheme

Filters the resulting URL after setting the scheme.

Description

apply_filters( 'set_url_scheme', (string) $url, (string) $scheme, (string|null) $orig_scheme ); 

Parameters (3)

0. $url (string)
The complete URL including scheme and path.
1. $scheme (string)
Scheme applied to the URL. One of http,, https., or relative.
2. $orig_scheme (string|null)
Scheme requested for the URL. One of http,, https, login, login_post, admin, relative, rest, rpc, or null.

Usage

To run the hook, copy the example below.
  1. $url = apply_filters( 'set_url_scheme', $url, $scheme, $orig_scheme ); 
  2.  
  3. if ( !empty( $url ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the set_url_scheme callback 
  2. function filter_set_url_scheme( $url, $scheme, $orig_scheme ) { 
  3. // make filter magic happen here... 
  4. return $url
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'set_url_scheme', 'filter_set_url_scheme', 10, 3 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'set_url_scheme', 'filter_set_url_scheme', 10, 3 ); 

Defined (1)

The filter is defined in the following location(s).

/wp-includes/link-template.php  
  1. return apply_filters( 'set_url_scheme', $url, $scheme, $orig_scheme );