auth_redirect_scheme

Filters the authentication redirect scheme.

Description

apply_filters( 'auth_redirect_scheme', (string) $var ); 

Parameters (1)

0. $var (string) => ''
Authentication redirect scheme. Default empty.

Usage

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

Defined (1)

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

/wp-includes/pluggable.php  
  1. $scheme = apply_filters( 'auth_redirect_scheme', '' );