How to use auth_redirect action in WordPress

auth_redirect action

Fires before the authentication redirect.

To use auth_redirect action, first you have to register it using add_action. 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 execute_on_auth_redirect_event which takes 1 parameter and we registered using add_action. The first parameter auth_redirect is the name of the hook, The second parameter execute_on_auth_redirect_event 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_action to remove auth_redirect action.

Parameters

Below the 1 parameter is required to use this hook.

• $user_id: (int) User ID.

Live Example

Trigger the auth_redirect action

Below is an example of how you can use this hook.

    function weplugins_execute_on_auth_redirect_event($user_id){
       // You can write code here to be executed when this action occurs in WordPress.
       // Use the parameters received in the function arguments & implement the required additional custom functionality according to your website requirements.
    }
    // add the action
    add_action("auth_redirect", "weplugins_execute_on_auth_redirect_event", 10, 1);
    

Remove the auth_redirect action

To remove a hook callback, use the example below.

    remove_action("auth_redirect", "weplugins_execute_on_auth_redirect_event", 10, 1);
    

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

Example of using auth_redirect with custom functionality

Here’s an example where we send an email notification when the auth_redirect action is triggered.

    function weplugins_notify_on_auth_redirect($user_id){
       $user_info = get_userdata($user_id);
       $email = $user_info->user_email;
       wp_mail($email, 'Authentication Redirect', 'You have been redirected for authentication.');
    }
    // add the action
    add_action("auth_redirect", "weplugins_notify_on_auth_redirect", 10, 1);