wp_parse_auth_cookie() — описание функции WordPress на русском

Сигнатура

wp_parse_auth_cookie( string $cookie = '', string $scheme = '' ): string[]|false

Описание

Разбирает cookie на составные части.

Параметры

$cookie string необязательный = ''

Cookie аутентификации.

$scheme string необязательный = ''

Схема cookie для использования: 'auth', 'secure_auth' или 'logged_in'.

Возвращаемое значение

string[]|false

username stringИмя пользователя. expiration stringВремя истечения срока действия cookie в виде временной метки UNIX. token stringИспользованный токен сессии пользователя. hmac stringЗащитный хеш cookie. scheme stringИспользуемая схема cookie.

Исходный код

wp-includes/pluggable.php:1013

function wp_parse_auth_cookie( $cookie = '', $scheme = '' ) {
	if ( empty( $cookie ) ) {
		switch ( $scheme ) {
			case 'auth':
				$cookie_name = AUTH_COOKIE;
				break;
			case 'secure_auth':
				$cookie_name = SECURE_AUTH_COOKIE;
				break;
			case 'logged_in':
				$cookie_name = LOGGED_IN_COOKIE;
				break;
			default:
				if ( is_ssl() ) {
					$cookie_name = SECURE_AUTH_COOKIE;
					$scheme      = 'secure_auth';
				} else {
					$cookie_name = AUTH_COOKIE;
					$scheme      = 'auth';
				}
		}

		if ( empty( $_COOKIE[ $cookie_name ] ) ) {
			return false;
		}
		$cookie = $_COOKIE[ $cookie_name ];
	}

	$cookie_elements = explode( '|', $cookie );
	if ( count( $cookie_elements ) !== 4 ) {
		return false;
	}

	list( $username, $expiration, $token, $hmac ) = $cookie_elements;

	return compact( 'username', 'expiration', 'token', 'hmac', 'scheme' );
}

История изменений

Версия	Описание
4.0.0	The $token element was added to the return value.
2.7.0	Introduced.