auth_redirect

Fires before the authentication redirect.

Description

do_action( 'auth_redirect', (int) $user_id ); 

Parameters (1)

0. $user_id (int)

The user id.

Usage

To run the hook, copy the example below.

// run the action 
do_action( 'auth_redirect', $user_id ); 

The following example is for adding a hook callback.

// define the auth_redirect callback 
function action_auth_redirect( $user_id ) { 
    // make action magic happen here... 
}; 
         
// add the action 
add_action( 'auth_redirect', 'action_auth_redirect', 10, 1 ); 

To remove a hook callback, use the example below.

// remove the action 
remove_action( 'auth_redirect', 'action_auth_redirect', 10, 1 );