password_change_email │ filter-hook │ WP 4.3.0

Filters the contents of the email sent when the user's password is changed.

Usage

add_filter( 'password_change_email', 'wp_kama_password_change_email_filter', 10, 3 );

/**
 * Function for `password_change_email` filter-hook.
 * 
 * @param array $pass_change_email Used to build wp_mail().
 * @param array $user              The original user array.
 * @param array $userdata          The updated user array.
 *
 * @return array
 */
function wp_kama_password_change_email_filter( $pass_change_email, $user, $userdata ){

	// filter...
	return $pass_change_email;
}

$pass_change_email(array)

Used to build wp_mail().

• to(string)
  The intended recipients. Add emails in a comma separated string.

• subject(string)
  The subject of the email.

• message(string)
  The content of the email.

  The following strings have a special meaning and will get replaced dynamically:
   - `###USERNAME###`    The current user's username.
   - `###ADMIN_EMAIL###` The admin email in case this was unexpected.
   - `###EMAIL###`       The user's email address.
   - `###SITENAME###`    The name of the site.
   - `###SITEURL###`     The URL to the site.

• headers(string)
  Headers. Add headers in a newline (\r\n) separated string.

$user(array)

The original user array.

$userdata(array)

The updated user array.

Changelog

Where the hook is called

$pass_change_email = apply_filters( 'password_change_email', $pass_change_email, $user, $userdata );

Where the hook is used in WordPress