wppaste
WordPress

do_action( 'retrieve_password', string $user_login )

Since
1.5.1
Fires before a new password is retrieved.

Compatibility

WordPress
since 1.5.1
  • 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).

Parameters

$user_loginstring
The user login name.

Where this hook fires · 1

  • wp-includes/user.php:3105get_password_reset_key()

Source code

	 * Fires before a new password is retrieved.	 *	 * @since 1.5.1	 *	 * @param string $user_login The user login name.	 */	do_action( 'retrieve_password', $user->user_login ); 	$password_reset_allowed = wp_is_password_reset_allowed_for_user( $user );	if ( ! $password_reset_allowed ) {		return new WP_Error( 'no_password_reset', __( 'Password reset is not allowed for this user' ) );	} elseif ( is_wp_error( $password_reset_allowed ) ) {		return $password_reset_allowed;

Changelog

Introduced in 1.5.1. 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.0.4 tag, 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.