How to use login_redirect filter in WordPress

login_redirect filter

Filters the login redirect URL.

To use the `login_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_login_redirect_defaults` which takes 3 parameters and we registered it using `add_filter`. The first parameter `login_redirect` is the name of the hook, the second parameter `modify_login_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 `login_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|WP_Error) WP_User object if login was successful, WP_Error object otherwise.

Live Examples

Example 1: Basic Login Redirect

In this example, we simply redirect users to the homepage after they log in.

	function weplugins_modify_login_redirect_defaults($redirect_to, $requested_redirect_to, $user) {
	    return home_url();
	}
	add_filter("login_redirect", "weplugins_modify_login_redirect_defaults", 10, 3);
	

Example 2: Conditional Login Redirect

This example redirects users to different pages based on their roles.

	function weplugins_modify_login_redirect_conditionally($redirect_to, $requested_redirect_to, $user) {
	    if (isset($user->roles) && in_array('administrator', $user->roles)) {
	        return admin_url();
	    } else {
	        return home_url('/user-dashboard');
	    }
	}
	add_filter("login_redirect", "weplugins_modify_login_redirect_conditionally", 10, 3);
	

Example 3: Remove Redirect Hook

If you need to remove the redirect hook, use the following code.

	remove_filter("login_redirect", "weplugins_modify_login_redirect_defaults", 10, 3);
	

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