函数文档

wp_get_user_request_data()

💡 云策文档标注

概述

wp_get_user_request_data() 是一个已弃用的 WordPress 函数,用于根据指定请求 ID 返回用户请求对象。自 WordPress 5.4.0 起,建议使用 wp_get_user_request() 替代。

关键要点

  • 函数 wp_get_user_request_data() 已弃用,自 WordPress 5.4.0 起应改用 wp_get_user_request()
  • 参数 $request_id 为必需整数,表示用户请求的 ID
  • 返回类型为 WP_User_Request 对象或 false
  • 函数内部调用 _deprecated_function() 标记弃用,并重定向到 wp_get_user_request()

代码示例

function wp_get_user_request_data( $request_id ) {
    _deprecated_function( __FUNCTION__, '5.4.0', 'wp_get_user_request()' );
    return wp_get_user_request( $request_id );
}

注意事项

  • 此函数在 WordPress 4.9.6 中引入,5.4.0 中弃用,开发者应更新代码以避免使用弃用函数
  • 相关函数包括 wp_get_user_request() 和 _deprecated_function(),用于替代和标记弃用

📄 原文内容

Return the user request object for the specified request ID.

Description

See also

Parameters

$request_idintrequired
The ID of the user request.

Return

WP_User_Request|false

Source

function wp_get_user_request_data( $request_id ) {
	_deprecated_function( __FUNCTION__, '5.4.0', 'wp_get_user_request()' );
	return wp_get_user_request( $request_id );
}

Changelog

Version Description
5.4.0 Deprecated. Use wp_get_user_request()
4.9.6 Introduced.