wppaste
WordPress

apply_filters( 'send_retrieve_password_email', bool $send, string $user_login, WP_User $user_data )

Since
6.0.0
Filters whether to send the retrieve password email.

Description

Return false to disable sending the email.

Compatibility

WordPress
since 6.0.0
  • 6.7.10
  • 6.8.11
  • 6.9.10
  • 7.0.7
  • 7.1.3

Present in every tracked release (6.7.10 to 7.1.3).

Parameters

$sendbool
Whether to send the email.
$user_loginstring
The username for the user.
$user_dataWP_User
WP_User object.

Where this hook fires · 1

  • wp-includes/user.php:3352retrieve_password()

Source code

	 * @since 6.0.0	 *	 * @param bool    $send       Whether to send the email.	 * @param string  $user_login The username for the user.	 * @param WP_User $user_data  WP_User object.	 */	if ( ! apply_filters( 'send_retrieve_password_email', true, $user_login, $user_data ) ) {		return true;	} 	// Redefining user_login ensures we return the right case in the email.	$user_login = $user_data->user_login;	$user_email = $user_data->user_email;

Changelog

Introduced in 6.0.0. Unchanged from 6.7.10 through 7.1.3.

  1. 6.7.10
  2. 6.8.11
  3. 6.9.10
  4. 7.0.7
  5. 7.1.3

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

About this page

Parsed data
Generated from the wordpress-develop 7.1.3 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.