wp_validate_user_request_key( string $request_id, string $key ): true|WP_Error

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$request_idstring

ID of the request being confirmed.

$keystring

Provided key to validate.

Return value

true|WP_Error

True on success, WP_Error on failure.

Performance profile

How much work a call to wp_validate_user_request_key() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reaches the database via get_post().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

24–62

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 95.

Plugin surface

1 hook

Third-party callbacks on 'user_request_key_expiration' run inside this call, and their cost is not bounded by anything here.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksapply_filters()called directly
• querycontent queryget_post()one call below wp_validate_user_request_key()

Further down the call graph this can also reach option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 4 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_validate_user_request_key() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

One hook fires while wp_validate_user_request_key() runs, in this order:

1. 1
   apply_filters( user_request_key_expiration )filterline 4961 (+32 into the body)

   Filters the expiration time of confirm keys.

Uses · 6

• absint()Converts a value to non-negative integer.
• wp_get_user_request()Returns the user request object for the specified request ID.
• __()Retrieves the translation of $text.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• WP_Error::__construct()Initializes the error.
• PasswordHash::__construct()

Source code

View on Trac ↗View on GitHub ↗

4929function wp_validate_user_request_key( $request_id, $key ) {4930	global $wp_hasher;4931 4932	$request_id       = absint( $request_id );4933	$request          = wp_get_user_request( $request_id );4934	$saved_key        = $request->confirm_key;4935	$key_request_time = $request->modified_timestamp;4936 4937	if ( ! $request || ! $saved_key || ! $key_request_time ) {4938		return new WP_Error( 'invalid_request', __( 'Invalid personal data request.' ) );4939	}4940 4941	if ( ! in_array( $request->status, array( 'request-pending', 'request-failed' ), true ) ) {4942		return new WP_Error( 'expired_request', __( 'This personal data request has expired.' ) );4943	}4944 4945	if ( empty( $key ) ) {4946		return new WP_Error( 'missing_key', __( 'The confirmation key is missing from this personal data request.' ) );4947	}4948 4949	if ( empty( $wp_hasher ) ) {4950		require_once ABSPATH . WPINC . '/class-phpass.php';4951		$wp_hasher = new PasswordHash( 8, true );4952	}4953 4954	/**4955	 * Filters the expiration time of confirm keys.4956	 *4957	 * @since 4.9.64958	 *4959	 * @param int $expiration The expiration time in seconds.4960	 */4961	$expiration_duration = (int) apply_filters( 'user_request_key_expiration', DAY_IN_SECONDS );4962	$expiration_time     = $key_request_time + $expiration_duration;4963 4964	if ( ! $wp_hasher->CheckPassword( $key, $saved_key ) ) {4965		return new WP_Error( 'invalid_key', __( 'The confirmation key is invalid for this personal data request.' ) );4966	}4967 4968	if ( ! $expiration_time || time() > $expiration_time ) {4969		return new WP_Error( 'expired_key', __( 'The confirmation key has expired for this personal data request.' ) );4970	}4971 4972	return true;4973}

Changelog

Introduced in 4.9.6. One change between 6.7.7 and 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-includes/user.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.