概述

wp_validate_user_request_key() 函数用于验证用户请求的确认密钥，确保个人数据请求的有效性和安全性。它通过比较提供的密钥与存储的密钥，并检查请求状态和过期时间，返回验证结果。

关键要点

• 函数参数：$request_id（整数，必需）为请求ID，$key（字符串，必需）为提供的验证密钥。
• 返回值：验证成功返回 true，失败返回 WP_Error 对象，包含错误代码和消息。
• 验证逻辑：检查请求是否存在、密钥是否匹配、请求状态是否为 'request-pending' 或 'request-failed'，以及密钥是否过期。
• 使用 Hook：apply_filters('user_request_key_expiration', int $expiration) 可过滤确认密钥的过期时间。
• 相关函数：包括 wp_get_user_request()、wp_verify_fast_hash()、absint() 等，用于辅助验证过程。

代码示例

function wp_validate_user_request_key(
    $request_id,
    #[SensitiveParameter]
    $key
) {
    $request_id       = absint( $request_id );
    $request          = wp_get_user_request( $request_id );
    $saved_key        = $request->confirm_key;
    $key_request_time = $request->modified_timestamp;

    if ( ! $request || ! $saved_key || ! $key_request_time ) {
        return new WP_Error( 'invalid_request', __( 'Invalid personal data request.' ) );
    }

    if ( ! in_array( $request->status, array( 'request-pending', 'request-failed' ), true ) ) {
        return new WP_Error( 'expired_request', __( 'This personal data request has expired.' ) );
    }

    if ( empty( $key ) ) {
        return new WP_Error( 'missing_key', __( 'The confirmation key is missing from this personal data request.' ) );
    }

    $expiration_duration = (int) apply_filters( 'user_request_key_expiration', DAY_IN_SECONDS );
    $expiration_time     = $key_request_time + $expiration_duration;

    if ( ! wp_verify_fast_hash( $key, $saved_key ) ) {
        return new WP_Error( 'invalid_key', __( 'The confirmation key is invalid for this personal data request.' ) );
    }

    if ( ! $expiration_time || time() > $expiration_time ) {
        return new WP_Error( 'expired_key', __( 'The confirmation key has expired for this personal data request.' ) );
    }

    return true;
}

注意事项

• 此函数自 WordPress 4.9.6 版本引入，主要用于处理个人数据请求的验证流程。
• 密钥验证使用 wp_verify_fast_hash() 进行哈希比较，确保安全性。
• 错误处理返回 WP_Error 对象，开发者应妥善处理这些错误以提供用户反馈。