How to use logout_url filter in WordPress

logout_url filter

Filters the logout URL.

To use the logout_url filter, first, you have to register it using add_filter. You can write this code into the functions.php of your activated theme or in a custom WordPress Plugin.

We at WePlugins always prefer to create a custom WordPress Plugin while using hooks so nothing breaks when you update your WordPress Theme in the future.

In the below live example, we have defined a function modify_logout_url_defaults which takes 2 parameters and we registered using add_filter. The first parameter logout_url is the name of the hook, The second parameter modify_logout_url_defaults is the name of the function which needs to be called, the third parameter is the priority of calling the hook if the same hook is used multiple times and the last parameter is the number of arguments (if any) to be passed in the registered function.

Sometimes, you have to remove a registered hook so you can use remove_filter to remove the logout_url filter.

Parameters

Below are the 2 parameters required to use this hook.

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

Live Example 1

This example shows how you can use this hook to redirect to a custom logout page.

add_filter( 'logout_url', 'weplugins_my_logout_page', 10, 2 );
function weplugins_my_logout_page( $logout_url, $redirect ) {
    return home_url( '/my-logout-page/?redirect_to=' . $redirect );
}

Live Example 2

Another example to modify the logout URL based on certain conditions.

function weplugins_modify_logout_url_defaults($logout_url, $redirect) { 
    // Update the $logout_url variable according to your website requirements and return this variable. You can modify the $logout_url variable conditionally too if you want.
    return $logout_url; 
}
// add the filter
add_filter( "logout_url", "weplugins_modify_logout_url_defaults", 10, 2 );

Live Example 3

To remove a hook callback, use the example below.

remove_filter( "logout_url", "weplugins_modify_logout_url_defaults", 10, 2 );

Please make sure to provide the same callback function name, priority, and number of arguments while removing the hook callback.

Contact Us

If you’re having any trouble using this hook or need customization, please contact us and we’d be happy to assist you.