set_auth_cookie │ action-hook │ WP 2.5.0

Fires immediately before the authentication cookie is set.

Usage

add_action( 'set_auth_cookie', 'wp_kama_set_auth_cookie_action', 10, 6 );

/**
 * Function for `set_auth_cookie` action-hook.
 * 
 * @param string $auth_cookie Authentication cookie value.
 * @param int    $expire      The time the login grace period expires as a UNIX timestamp.
 * @param int    $expiration  The time when the authentication cookie expires as a UNIX timestamp.
 * @param int    $user_id     User ID.
 * @param string $scheme      Authentication scheme. Values include 'auth' or 'secure_auth'.
 * @param string $token       User's session token to use for this cookie.
 *
 * @return void
 */
function wp_kama_set_auth_cookie_action( $auth_cookie, $expire, $expiration, $user_id, $scheme, $token ){

	// action...
}

$auth_cookie(string)

Authentication cookie value.

$expire(int)

The time the login grace period expires as a UNIX timestamp.
Default: 12 hours past the cookie's expiration time

$expiration(int)

The time when the authentication cookie expires as a UNIX timestamp.
Default: 14 days from now

$user_id(int)

User ID.

$scheme(string)

Authentication scheme. Values include 'auth' or 'secure_auth'.

$token(string)

User's session token to use for this cookie.

Changelog

Where the hook is called

do_action( 'set_auth_cookie', $auth_cookie, $expire, $expiration, $user_id, $scheme, $token );

Where the hook is used in WordPress