check_password_reset_key( string $key, string $login ): WP_User|WP_Error

Description

Compatibility

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

Parameters

$keystring

The password reset key.

$loginstring

The user login.

Return value

WP_User|WP_Error

WP_User object on success, WP_Error object for invalid or expired keys.

Performance profile

How much work a call to check_password_reset_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_user_by().

Scaling

Constant

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

Instructions

15–76

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

Plugin surface

2 hooks

Third-party callbacks on 'password_reset_expiration', 'password_reset_key_expired' 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

• querycontent queryget_user_by()called directly
• hookthird-party callbacksapply_filters()called directly

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 · 18 distinct outcomes

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

Hooks and filters fired · 2

2 hooks fire while check_password_reset_key() runs, in this order:

1. 1
   apply_filters( password_reset_expiration )filterline 3204 (+28 into the body)

   Filters the expiration time of password reset keys.

2. 2
   apply_filters( password_reset_key_expired )filterline 3244 (+68 into the body)

   Filters the return value of check_password_reset_key() when an old-style key or an expired key is used.

Uses · 6

• __()Retrieves the translation of $text.
• get_user_by()Retrieves user info by a given field.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• str_contains()Polyfill for `str_contains()` function added in PHP 8.0.
• wp_verify_fast_hash()Checks whether a plaintext message matches the hashed value. Used to verify values hashed via wp_fast_hash().
• WP_Error::__construct()Initializes the error.

Source code

View on Trac ↗View on GitHub ↗

3176function check_password_reset_key(3177	#[\SensitiveParameter]3178	$key,3179	$login3180) {3181	$key = preg_replace( '/[^a-z0-9]/i', '', $key );3182 3183	if ( empty( $key ) || ! is_string( $key ) ) {3184		return new WP_Error( 'invalid_key', __( 'Invalid key.' ) );3185	}3186 3187	if ( empty( $login ) || ! is_string( $login ) ) {3188		return new WP_Error( 'invalid_key', __( 'Invalid key.' ) );3189	}3190 3191	$user = get_user_by( 'login', $login );3192 3193	if ( ! $user ) {3194		return new WP_Error( 'invalid_key', __( 'Invalid key.' ) );3195	}3196 3197	/**3198	 * Filters the expiration time of password reset keys.3199	 *3200	 * @since 4.3.03201	 *3202	 * @param int $expiration The expiration time in seconds.3203	 */3204	$expiration_duration = apply_filters( 'password_reset_expiration', DAY_IN_SECONDS );3205 3206	if ( str_contains( $user->user_activation_key, ':' ) ) {3207		list( $pass_request_time, $pass_key ) = explode( ':', $user->user_activation_key, 2 );3208		$expiration_time                      = $pass_request_time + $expiration_duration;3209	} else {3210		$pass_key        = $user->user_activation_key;3211		$expiration_time = false;3212	}3213 3214	if ( ! $pass_key ) {3215		return new WP_Error( 'invalid_key', __( 'Invalid key.' ) );3216	}3217 3218	$hash_is_correct = wp_verify_fast_hash( $key, $pass_key );3219 3220	if ( $hash_is_correct && $expiration_time && time() < $expiration_time ) {3221		return $user;3222	} elseif ( $hash_is_correct && $expiration_time ) {3223		// Key has an expiration time that's passed.3224		return new WP_Error( 'expired_key', __( 'Invalid key.' ) );3225	}3226 3227	if ( hash_equals( $user->user_activation_key, $key ) || ( $hash_is_correct && ! $expiration_time ) ) {3228		$return  = new WP_Error( 'expired_key', __( 'Invalid key.' ) );3229		$user_id = $user->ID;3230 3231		/**3232		 * Filters the return value of check_password_reset_key() when an3233		 * old-style key or an expired key is used.3234		 *3235		 * Prior to 3.7, plain-text keys were stored in the database.3236		 *3237		 * @since 3.7.03238		 * @since 4.3.0 Previously key hashes were stored without an expiration time.3239		 *3240		 * @param WP_Error $return  A WP_Error object denoting an expired key.3241		 *                          Return a WP_User object to validate the key.3242		 * @param int      $user_id The matched user ID.3243		 */3244		return apply_filters( 'password_reset_key_expired', $return, $user_id );3245	}3246 3247	return new WP_Error( 'invalid_key', __( 'Invalid key.' ) );3248}

Changelog

Introduced in 3.1.0. Unchanged from 6.7.7 through 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 7.1.0 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.