logout_url

Filters the logout URL.

Description

apply_filters( 'logout_url', (string) $logout_url, (string) $redirect ); 

Parameters (2)

0. $logout_url (string)
The HTML-encoded logout URL.
1. $redirect (string)
Path to redirect to on logout.

Usage

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

Defined (1)

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

/wp-includes/general-template.php  
  1. return apply_filters( 'logout_url', $logout_url, $redirect );