wp_password_change_notification( WP_User $user )

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 object.

Performance profile

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

12–86

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

Plugin surface

1 hook

Third-party callbacks on 'wp_password_change_notification_email' 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

• optionoption read or writeget_option()called directly
• querycontent queryget_user_by()called directly
• hookthird-party callbacksapply_filters()called directly
• mailsends mailwp_mail()called directly
• cacheobject cachewp_cache_get()one call below wp_password_change_notification()
• serializeserialisationmaybe_unserialize()one call below wp_password_change_notification()

Further down the call graph this can also reach transient. That is the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 5 distinct outcomes

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

Hooks and filters fired · 1

One hook fires while wp_password_change_notification() runs, in this order:

1. 1
   apply_filters( wp_password_change_notification_email )filterline 2234 (+47 into the body)

   Filters the contents of the password change notification email sent to the site admin.

Uses · 10

• get_option()Retrieves an option value based on an option name.
• get_user_by()Retrieves user info by a given field.
• switch_to_user_locale()Switches the translations according to the given user's locale.
• switch_to_locale()Switches the translations according to the given locale.
• get_locale()Retrieves the current locale.
• __()Retrieves the translation of $text.
• wp_specialchars_decode()Converts a number of HTML entities into their special characters.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• wp_mail()Sends an email, similar to PHP's mail function.
• restore_previous_locale()Restores the translations according to the previous locale.

Source code

View on Trac ↗View on GitHub ↗

2187	function wp_password_change_notification( $user ) {2188		/*2189		 * Send a copy of password change notification to the admin,2190		 * but check to see if it's the admin whose password we're changing, and skip this.2191		 */2192		if ( 0 !== strcasecmp( $user->user_email, get_option( 'admin_email' ) ) ) {2193 2194			$admin_user = get_user_by( 'email', get_option( 'admin_email' ) );2195 2196			if ( $admin_user ) {2197				$switched_locale = switch_to_user_locale( $admin_user->ID );2198			} else {2199				$switched_locale = switch_to_locale( get_locale() );2200			}2201 2202			/* translators: %s: User name. */2203			$message = sprintf( __( 'Password changed for user: %s' ), $user->user_login ) . "\r\n";2204			/*2205			 * The blogname option is escaped with esc_html() on the way into the database in sanitize_option().2206			 * We want to reverse this for the plain text arena of emails.2207			 */2208			$blogname = wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES );2209 2210			$wp_password_change_notification_email = array(2211				'to'      => get_option( 'admin_email' ),2212				/* translators: Password change notification email subject. %s: Site title. */2213				'subject' => __( '[%s] Password Changed' ),2214				'message' => $message,2215				'headers' => '',2216			);2217 2218			/**2219			 * Filters the contents of the password change notification email sent to the site admin.2220			 *2221			 * @since 4.9.02222			 *2223			 * @param array   $wp_password_change_notification_email {2224			 *     Used to build wp_mail().2225			 *2226			 *     @type string $to      The intended recipient - site admin email address.2227			 *     @type string $subject The subject of the email.2228			 *     @type string $message The body of the email.2229			 *     @type string $headers The headers of the email.2230			 * }2231			 * @param WP_User $user     User object for user whose password was changed.2232			 * @param string  $blogname The site title.2233			 */2234			$wp_password_change_notification_email = apply_filters( 'wp_password_change_notification_email', $wp_password_change_notification_email, $user, $blogname );2235 2236			wp_mail(2237				$wp_password_change_notification_email['to'],2238				wp_specialchars_decode( sprintf( $wp_password_change_notification_email['subject'], $blogname ) ),2239				$wp_password_change_notification_email['message'],2240				$wp_password_change_notification_email['headers']2241			);2242 2243			if ( $switched_locale ) {2244				restore_previous_locale();2245			}2246		}2247	}

Changelog

Introduced in 2.7.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.9.7 tag, from src/wp-includes/pluggable.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.