apply_filters( ‘login_redirect’, string $redirect_to, string $requested_redirect_to, WP_User|WP_Error $user )

Filters the login redirect URL.

Parameters

$redirect_tostring
The redirect destination URL.
$requested_redirect_tostring
The requested redirect destination URL passed as a parameter.
$userWP_User|WP_Error
WP_User object if login was successful, WP_Error object otherwise.

More Information

The $current_user global may not be available at the time this filter is run. So you should use the $user global or the $user parameter passed to this filter.

Source

$redirect_to = apply_filters( 'login_redirect', $redirect_to, $requested_redirect_to, $user );

Changelog

VersionDescription
3.0.0Introduced.

User Contributed Notes

  1. Skip to note 5 content

    Examples

    This example redirects admins to the dashboard and other users to the homepage. Make sure you use add_filter outside of is_admin() , since that function is not available when the filter is called.

    /**
     * Redirect user after successful login.
     *
     * @param string $redirect_to URL to redirect to.
     * @param string $request URL the user is coming from.
     * @param object $user Logged user's data.
     * @return string
     */
    function my_login_redirect( $redirect_to, $request, $user ) {
    	//is there a user to check?
    	if ( isset( $user->roles ) && is_array( $user->roles ) ) {
    		//check for admins
    		if ( in_array( 'administrator', $user->roles ) ) {
    			// redirect them to the default place
    			return $redirect_to;
    		} else {
    			return home_url();
    		}
    	} else {
    		return $redirect_to;
    	}
    }
    
    add_filter( 'login_redirect', 'my_login_redirect', 10, 3 );
  2. Skip to note 6 content

    Notes

    You can register the login_redirect filter to use all 3 parameters like this:

    <?php add_filter( 'login_redirect', 'filter_function_name', 10, 3 ); ?>

    In the example, ‘filter_function_name’ is the function WordPress should call during the login process. Note that filter_function_name should be unique function name. It cannot match any other function name already declared.

    The $current_user global may not be available at the time this filter is run. So you should use the $user global or the $user parameter passed to this filter.

  3. Skip to note 8 content
    <?php 
    
    /**
     * WordPress function for redirecting users on login based on user role
     */
    function wpdocs_my_login_redirect( $url, $request, $user ) {
        if ( $user && is_object( $user ) && is_a( $user, 'WP_User' ) ) {
            if ( $user->has_cap( 'administrator' ) ) {
                $url = admin_url();
            } else {
                $url = home_url( '/members-only/' );
            }
        }
        return $url;
    }
    
    add_filter( 'login_redirect', 'wpdocs_my_login_redirect', 10, 3 );

    Thanks WP Scholar : https://wpscholar.com/blog/wordpress-user-login-redirect/ :D

You must log in before being able to contribute a note or feedback.