wordpress / latest / functions / _wp_privacy_completed_request.html

_wp_privacy_completed_request( int $request_id ): int|WP_Error

This function’s access is marked private. This means it is not intended for use by plugin or theme developers, only in other core functions. It is listed here for completeness.

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

Parameters

$request_id int Required
Request ID.

Return

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

Source

File: wp-admin/includes/privacy-tools.php. View all references

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;
}

Uses

Uses Description

Changelog

Version Description
4.9.6 Introduced.

© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/_wp_privacy_completed_request