login_redirect

Filters the login redirect URL.

Description

apply_filters( 'login_redirect', (unknown) $redirect_to, (unknown) $request_redirect_to, (unknown) $user ); 

Parameters (3)

0. $redirect_to (unknown)
The redirect to.
1. $request_redirect_to (unknown)
The request redirect to.
2. $user (unknown)
The user.

Usage

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

Defined (1)

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

/modules/sso.php  
  1. apply_filters( 'login_redirect', $redirect_to, $_request_redirect_to, $user )