How to use logout_redirect filter in WordPress

logout_redirect filter

Filters the log out redirect URL.

To use the logout_redirect filter, first, you have to register it using add_filter. You can write this code into 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_redirect_defaults which takes 3 parameters and we registered it using add_filter. The first parameter logout_redirect is the name of the hook, The second parameter modify_logout_redirect_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_redirect filter.

Parameters

Below are the 3 parameters required to use this hook.

• $redirect_to : (string) The redirect destination URL.
• $requested_redirect_to : (string) The requested redirect destination URL passed as a parameter.
• $user : (WP_User) The WP_User object for the user that’s logging out.

Live Example

Example 1: Redirect Admin Users to Admin Dashboard

In this example, we check if the user has an admin role and redirect them to the admin dashboard.

    function weplugins_logout_redirect( $redirect_to, $requested_redirect_to, $user ) {
        $user_roles = $user->roles;
        $user_has_admin_role = in_array( 'administrator', $user_roles );
        if ( $user_has_admin_role ) :
            $redirect_to = admin_url();
        else:
            $redirect_to = home_url();
        endif;
        return $redirect_to;
    }
    add_filter( "logout_redirect", "weplugins_logout_redirect", 10, 3 );
    

Example 2: Custom Redirect URL based on User Role

This example shows how you can customize the redirect URL based on different user roles.

    function weplugins_custom_logout_redirect( $redirect_to, $requested_redirect_to, $user ) {
        if ( in_array( 'editor', $user->roles ) ) {
            $redirect_to = site_url( '/editor-dashboard' );
        } elseif ( in_array( 'subscriber', $user->roles ) ) {
            $redirect_to = site_url( '/subscriber-dashboard' );
        }
        return $redirect_to;
    }
    add_filter( "logout_redirect", "weplugins_custom_logout_redirect", 10, 3 );
    

Example 3: Remove a Hook Callback

To remove a hook callback, use the example below. Please make sure to provide the same callback function name, priority, and number of arguments while removing the hook callback.

    function weplugins_modify_logout_redirect_defaults($redirect_to, $requested_redirect_to, $user) {
        return $redirect_to;
    }
    add_filter( "logout_redirect", "weplugins_modify_logout_redirect_defaults", 10, 3 );

    remove_filter( "logout_redirect", "weplugins_modify_logout_redirect_defaults", 10, 3 );
    

Contact Us

If you’re having any trouble using this hook, please contact our WordPress Development Team and we’d be happy to assist you.