get_password_reset_key( WP_User $user ): string|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

$userWP_User

User to retrieve password reset key for.

Return value

string|WP_Error

Password reset key on success. WP_Error on error.

Performance profile

How much work a call to get_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

Expensive

Sends mail via wp_mail().

Scaling

Constant

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

Instructions

11–57

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

Plugin surface

3 hooks

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

Called by

2

2 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksdo_action_deprecated()called directly
• optionoption read or writeget_option()one call below get_password_reset_key()
• mailsends mailwp_mail()one call below get_password_reset_key()

Further down the call graph this can also reach query, transient, cache and serialize. 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 get_password_reset_key() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 3

3 hooks fire while get_password_reset_key() runs, in this order:

1. 1
   do_action( retreive_password )action_deprecatedline 3025 (+15 into the body)

   Fires before a new password is retrieved.

2. 2
   do_action( retrieve_password )actionline 3034 (+24 into the body)

   Fires before a new password is retrieved.

3. 3
   do_action( retrieve_password_key )actionline 3054 (+44 into the body)

   Fires when a password reset key is generated.

Uses · 9

• __()Retrieves the translation of $text.
• do_action_deprecated()Fires functions attached to a deprecated action hook.
• do_action()Calls the callback functions that have been added to an action hook.
• wp_is_password_reset_allowed_for_user()Checks if password reset is allowed for a specific user.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• wp_generate_password()Generates a random password drawn from the defined set of characters.
• wp_fast_hash()Returns a cryptographically secure hash of a message using a fast generic hash function.
• wp_update_user()Updates a user in the database.
• WP_Error::__construct()Initializes the error.

Used by · 2

• retrieve_password()Handles sending a password retrieval email to a user.
• wp_new_user_notification()Emails login credentials to a newly-registered user.

Source code

View on Trac ↗View on GitHub ↗

3010function get_password_reset_key( $user ) {3011	if ( ! ( $user instanceof WP_User ) ) {3012		return new WP_Error( 'invalidcombo', __( '<strong>Error:</strong> There is no account with that username or email address.' ) );3013	}3014 3015	/**3016	 * Fires before a new password is retrieved.3017	 *3018	 * Use the {@see 'retrieve_password'} hook instead.3019	 *3020	 * @since 1.5.03021	 * @deprecated 1.5.1 Misspelled. Use {@see 'retrieve_password'} hook instead.3022	 *3023	 * @param string $user_login The user login name.3024	 */3025	do_action_deprecated( 'retreive_password', array( $user->user_login ), '1.5.1', 'retrieve_password' );3026 3027	/**3028	 * Fires before a new password is retrieved.3029	 *3030	 * @since 1.5.13031	 *3032	 * @param string $user_login The user login name.3033	 */3034	do_action( 'retrieve_password', $user->user_login );3035 3036	$password_reset_allowed = wp_is_password_reset_allowed_for_user( $user );3037	if ( ! $password_reset_allowed ) {3038		return new WP_Error( 'no_password_reset', __( 'Password reset is not allowed for this user' ) );3039	} elseif ( is_wp_error( $password_reset_allowed ) ) {3040		return $password_reset_allowed;3041	}3042 3043	// Generate something random for a password reset key.3044	$key = wp_generate_password( 20, false );3045 3046	/**3047	 * Fires when a password reset key is generated.3048	 *3049	 * @since 2.5.03050	 *3051	 * @param string $user_login The username for the user.3052	 * @param string $key        The generated password reset key.3053	 */3054	do_action( 'retrieve_password_key', $user->user_login, $key );3055 3056	$hashed = time() . ':' . wp_fast_hash( $key );3057 3058	$key_saved = wp_update_user(3059		array(3060			'ID'                  => $user->ID,3061			'user_activation_key' => $hashed,3062		)3063	);3064 3065	if ( is_wp_error( $key_saved ) ) {3066		return $key_saved;3067	}3068 3069	return $key;3070}

Changelog

Introduced in 4.4.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 6.8.8 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.