云策 WordPress 开发者社区

函数文档

wp_get_session_token()

查看官方原文 ↗
💡 云策文档标注

概述

wp_get_session_token() 函数用于从 logged_in cookie 中检索当前会话令牌，返回字符串形式的令牌或空字符串。

关键要点

  • 函数从 logged_in cookie 解析并返回当前会话令牌
  • 返回类型为字符串，若无令牌则返回空字符串
  • 内部调用 wp_parse_auth_cookie() 进行 cookie 解析
  • 自 WordPress 4.0.0 版本引入

代码示例

function wp_get_session_token() {
    $cookie = wp_parse_auth_cookie( '', 'logged_in' );
    return ! empty( $cookie['token'] ) ? $cookie['token'] : '';
}

注意事项

  • 函数依赖于 wp_parse_auth_cookie() 正确解析 cookie 组件
  • 常用于会话管理相关功能，如销毁会话或验证 nonce
📄 原文内容

Retrieves the current session token from the logged_in cookie.

Return

string Token.

Source

function wp_get_session_token() {
	$cookie = wp_parse_auth_cookie( '', 'logged_in' );
	return ! empty( $cookie['token'] ) ? $cookie['token'] : '';
}

View all references View on Trac View on GitHub

Uses Description
wp_parse_auth_cookie()wp-includes/pluggable.php

Parses a cookie into its components.
Used by Description
wp_ajax_destroy_sessions()wp-admin/includes/ajax-actions.php

Handles destroying multiple open sessions for a user via AJAX.
wp_destroy_current_session()wp-includes/user.php

Removes the current session token from the database.
wp_destroy_other_sessions()wp-includes/user.php

Removes all but the current session token for the current user for the database.
wp_verify_nonce()wp-includes/pluggable.php

Verifies that a correct security nonce was used with time limit.
wp_create_nonce()wp-includes/pluggable.php

Creates a cryptographic token tied to a specific action, user, user session, and window of time.

Changelog

Version Description
4.0.0 Introduced.