wp_generate_auth_cookie() WordPress Function
The wp_generate_auth_cookie() function is used to generate authentication cookies for logged-in users. These cookies are used to authenticate the user on subsequent visits to the site. The function takes three parameters: the user ID, the authentication token, and a Boolean value indicating whether the cookie should be marked as secure. The user ID and authentication token are used to create a hash, which is then stored in the cookie. If the secure parameter is set to true, the cookie will only be sent over HTTPS connections. The wp_generate_auth_cookie() function is used internally by the Wordpress login system. It should not be called directly by plugins or themes.
wp_generate_auth_cookie( int $user_id, int $expiration, string $scheme = 'auth', string $token = '' ) #
Generates authentication cookie contents.
Parameters
- $user_id
(int)(Required)User ID.
- $expiration
(int)(Required)The time the cookie expires as a UNIX timestamp.
- $scheme
(string)(Optional) The cookie scheme to use: 'auth', 'secure_auth', or 'logged_in'.
Default value: 'auth'
- $token
(string)(Optional)User's session token to use for this cookie.
Default value: ''
Return
(string) Authentication cookie contents. Empty string if user does not exist.
Source
File: wp-includes/pluggable.php
function wp_generate_auth_cookie( $user_id, $expiration, $scheme = 'auth', $token = '' ) { $user = get_userdata( $user_id ); if ( ! $user ) { return ''; } if ( ! $token ) { $manager = WP_Session_Tokens::get_instance( $user_id ); $token = $manager->create( $expiration ); } $pass_frag = substr( $user->user_pass, 8, 4 ); $key = wp_hash( $user->user_login . '|' . $pass_frag . '|' . $expiration . '|' . $token, $scheme ); // If ext/hash is not present, compat.php's hash_hmac() does not support sha256. $algo = function_exists( 'hash' ) ? 'sha256' : 'sha1'; $hash = hash_hmac( $algo, $user->user_login . '|' . $expiration . '|' . $token, $key ); $cookie = $user->user_login . '|' . $expiration . '|' . $token . '|' . $hash; /** * Filters the authentication cookie. * * @since 2.5.0 * @since 4.0.0 The `$token` parameter was added. * * @param string $cookie Authentication cookie. * @param int $user_id User ID. * @param int $expiration The time the cookie expires as a UNIX timestamp. * @param string $scheme Cookie scheme used. Accepts 'auth', 'secure_auth', or 'logged_in'. * @param string $token User's session token used. */ return apply_filters( 'auth_cookie', $cookie, $user_id, $expiration, $scheme, $token ); }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
4.0.0 | The $token parameter was added. |
2.5.0 | Introduced. |