logout_redirect

Filters the log out redirect URL.

Description

apply_filters( 'logout_redirect', (string) $redirect_to, (string) $requested_redirect_to, (WP_User) $user ); 

Parameters (3)

0. $redirect_to (string)
The redirect destination URL.
1. $requested_redirect_to (string)
The requested redirect destination URL passed as a parameter.
2. $user (WP_User)
The WP_User object for the user that's logging out.

Usage

To run the hook, copy the example below.
  1. $redirect_to = apply_filters( 'logout_redirect', $redirect_to, $requested_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 logout_redirect callback 
  2. function filter_logout_redirect( $redirect_to, $requested_redirect_to, $user ) { 
  3. // make filter magic happen here... 
  4. return $redirect_to
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'logout_redirect', 'filter_logout_redirect', 10, 3 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'logout_redirect', 'filter_logout_redirect', 10, 3 ); 

Defined (1)

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

/wp-login.php  
  1. $redirect_to = apply_filters( 'logout_redirect', $redirect_to, $requested_redirect_to, $user );