set_auth_cookie action-hook . WP 2.5.0
Fires immediately before the authentication cookie is set.
Usage
add_action( 'set_auth_cookie', 'action_function_name_9791', 10, 6 ); function action_function_name_9791( $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
Since 2.5.0 | Introduced. |
Since 4.9.0 | The $token parameter was added. |
Where the hook is called
set_auth_cookie
wp-includes/pluggable.php 928
do_action( 'set_auth_cookie', $auth_cookie, $expire, $expiration, $user_id, $scheme, $token );