WP_Recovery_Mode_Key_Service::validate_recovery_mode_key( string $token, string $key, int $ttl ): true|WP_Error
- Since
- 5.2.0
- Source
wp-includes/class-wp-recovery-mode-key-service.php:82
Description
Recovery mode keys can only be used once; the key will be consumed in the process.
Compatibility
- WordPress
- since 5.2.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$tokenstring- The token used when generating the given key.
$keystring- The plain text key.
$ttlint- Time in seconds for the key to be valid for.
Return value
true|WP_Error- True on success, error object on failure.
Performance profile
How much work a call to WP_Recovery_Mode_Key_Service::validate_recovery_mode_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
- Trivial
- Scaling
- Constant
- Instructions
- 16–39
- Plugin surface
- None
- Called by
- 0
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 64.
Nothing here hands control to plugin code.
Nothing in core calls this; the cost is only what you spend yourself.
What one call costs · 5 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Recovery_Mode_Key_Service::validate_recovery_mode_key() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!isset($records[$token]) | 16 | ->get_keys(), __() |
isset($records[$token]) | 22–26 | ->get_keys(), ->remove_key(), __() |
isset($records[$token]) && is_array($record) && isset($record) && wp_verify_fast_hash() | 32 | ->get_keys(), ->remove_key(), wp_verify_fast_hash(), time() |
isset($records[$token]) && is_array($record) && isset($record) && !wp_verify_fast_hash() | 33 | ->get_keys(), ->remove_key(), wp_verify_fast_hash(), __() |
isset($records[$token]) && is_array($record) && isset($record) && wp_verify_fast_hash() | 39 | ->get_keys(), ->remove_key(), wp_verify_fast_hash(), time(), __() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 64 instructions, 16–39 executed per call, 6 branches. The work does not change between versions.
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 5
- __()Retrieves the translation of $text.
- wp_verify_fast_hash()Checks whether a plaintext message matches the hashed value. Used to verify values hashed via wp_fast_hash().
- WP_Recovery_Mode_Key_Service::get_keys()Gets the recovery key records.
- WP_Error::__construct()Initializes the error.
- WP_Recovery_Mode_Key_Service::remove_key()Removes a used recovery key.
Source code
public function validate_recovery_mode_key( $token, $key, $ttl ) { $records = $this->get_keys(); if ( ! isset( $records[ $token ] ) ) { return new WP_Error( 'token_not_found', __( 'Recovery Mode not initialized.' ) ); } $record = $records[ $token ]; $this->remove_key( $token ); if ( ! is_array( $record ) || ! isset( $record['hashed_key'], $record['created_at'] ) ) { return new WP_Error( 'invalid_recovery_key_format', __( 'Invalid recovery key format.' ) ); } if ( ! wp_verify_fast_hash( $key, $record['hashed_key'] ) ) { return new WP_Error( 'hash_mismatch', __( 'Invalid recovery key.' ) ); } if ( time() > $record['created_at'] + $ttl ) { return new WP_Error( 'key_expired', __( 'Recovery key expired.' ) ); } return true; }Changelog
Introduced in 5.2.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 tag, from
src/wp-includes/class-wp-recovery-mode-key-service.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.