wp_get_user_request()
云策文档标注
概述
wp_get_user_request() 函数用于根据指定的请求 ID 返回用户请求对象。它通过验证 post 类型并实例化 WP_User_Request 类来实现。
关键要点
- 参数 $request_id 为必需整数，表示用户请求的 ID。
- 返回 WP_User_Request 对象或 false（如果请求不存在或类型不匹配）。
- 函数内部使用 absint() 确保参数为非负整数，并通过 get_post() 获取 post 数据。
- 主要用于 WordPress 隐私数据处理，如导出或擦除个人数据请求。
代码示例
function wp_get_user_request( $request_id ) {
$request_id = absint( $request_id );
$post = get_post( $request_id );
if ( ! $post || 'user_request' !== $post->post_type ) {
return false;
}
return new WP_User_Request( $post );
}注意事项
- 确保传入的 $request_id 是有效的用户请求 ID，否则可能返回 false。
- 此函数自 WordPress 4.9.6 版本引入，与隐私功能紧密相关。
原文内容
Returns the user request object for the specified request ID.
Parameters
$request_idintrequired-
The ID of the user request.
Source
function wp_get_user_request( $request_id ) {
$request_id = absint( $request_id );
$post = get_post( $request_id );
if ( ! $post || 'user_request' !== $post->post_type ) {
return false;
}
return new WP_User_Request( $post );
}
Changelog
| Version | Description |
|---|---|
| 4.9.6 | Introduced. |