Question

wp_generate_auth_cookie( int $user_id,  int $expiration,  string $scheme = 'auth',  string $token = '' )

Generate authentication cookie contents.

---

description

---

参数

$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: ''

---

返回值

(string) Authentication cookie contents. Empty string if user does not exist.

---

源代码

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
	 *
	 * @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 );
}

---

更新日志

Version	description
2.5.0	Introduced.

---

相关函数

Uses

• wp-includes/class-wp-session-tokens.php: WP_Session_Tokens::get_instance()
• wp-includes/pluggable.php: wp_hash()
• wp-includes/pluggable.php: auth_cookie
• wp-includes/pluggable.php: get_userdata()
• wp-includes/plugin.php: apply_filters()

---

Used By

• wp-includes/pluggable.php: wp_set_auth_cookie()

---

User Contributed Notes