login_redirect filter
Filters the login redirect URL.
To use 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 Flipper Code, 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 using add_filter. The first parameter login_redirect is name of the hook, The second parameter modify_login_redirect_defaults is name of the function which need to be called, third parameter is the priority of calling the hook if same hook is used multiple times and the last parameter is the number of arguments (if any) to be passed in the registered function.
Sometime, you have to remove a registered hook so you can use remove_filter to remove login_redirect filter.
Parameters
- $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.
Below are the 3 parameters are required to use this hook.
Live Example
/**
* 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?
Below is an example how you can use this hook.
function modify_login_redirect_defaults($redirect_to, $requested_redirect_to, $user) {
// Update the $redirect_to variable according to your website requirements and return this variable. You can modify the $redirect_to variable conditionally too if you want.
return $redirect_to;
}
// add the filter
add_filter( "login_redirect", "modify_login_redirect_defaults", 10, 3 );
To remove a hook callback, use the example below.
remove_filter( "login_redirect", "modify_login_redirect_defaults", 10, 3 );
Please make sure provide the same callback function name, priority and number of arguments while removing the hook callback.
Flipper Code is a Premium WordPress Plugins development company and integrating new functionalites into WordPress sites in form of custom WordPress Plugins since 2012. If you’re having any trouble using this hook, please contact our WordPress Development Team and we’d be happy to assist you.
