函数文档

_wp_privacy_completed_request()

💡 云策文档标注

概述

_wp_privacy_completed_request() 是一个 WordPress 函数,用于将个人数据请求标记为已完成,并记录完成时间戳。它处理请求 ID,更新相关元数据和帖子状态。

关键要点

  • 函数接受一个必需的整数参数 $request_id,表示请求 ID。
  • 成功时返回请求 ID,失败时返回 WP_Error 对象。
  • 内部使用 wp_get_user_request() 验证请求,update_post_meta() 记录时间戳,wp_update_post() 更新帖子状态为 'request-completed'。
  • 相关函数包括 wp_get_user_request()、wp_update_post()、update_post_meta()、__()、absint() 和 WP_Error::__construct()。
  • 该函数在 WordPress 4.9.6 版本中引入。

代码示例

function _wp_privacy_completed_request( $request_id ) {
    // Get the request.
    $request_id = absint( $request_id );
    $request    = wp_get_user_request( $request_id );

    if ( ! $request ) {
        return new WP_Error( 'privacy_request_error', __( 'Invalid personal data request.' ) );
    }

    update_post_meta( $request_id, '_wp_user_request_completed_timestamp', time() );

    $result = wp_update_post(
        array(
            'ID'          => $request_id,
            'post_status' => 'request-completed',
        )
    );

    return $result;
}

注意事项

  • 函数主要用于隐私工具处理,如个人数据导出和擦除请求的完成操作。
  • 调用前需确保请求 ID 有效,否则会返回 WP_Error。
  • 该函数是内部函数,通常通过管理界面或相关钩子间接调用。

📄 原文内容

Marks a request as completed by the admin and logs the current timestamp.

Parameters

$request_idintrequired
Request ID.

Return

int|WP_Error Request ID on success, or a WP_Error on failure.

Source

function _wp_privacy_completed_request( $request_id ) {
	// Get the request.
	$request_id = absint( $request_id );
	$request    = wp_get_user_request( $request_id );

	if ( ! $request ) {
		return new WP_Error( 'privacy_request_error', __( 'Invalid personal data request.' ) );
	}

	update_post_meta( $request_id, '_wp_user_request_completed_timestamp', time() );

	$result = wp_update_post(
		array(
			'ID'          => $request_id,
			'post_status' => 'request-completed',
		)
	);

	return $result;
}

Changelog

Version Description
4.9.6 Introduced.