wp_new_user_notification( int $user_id, mixed $deprecated = null, string $notify = '' )

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$user_idint

User ID.

$deprecatedmixedoptional

Not used.Default: null

$notifystringoptional

Type of notification that should happen. Accepts 'admin' or an empty string (admin only), 'user', or 'both' (admin and user). Default empty.Default: ''

Performance profile

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

8–204

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

Plugin surface

4 hooks

Third-party callbacks on 'wp_send_new_user_notification_to_admin', 'wp_new_user_notification_email_admin', 'wp_send_new_user_notification_to_user' run inside this call, and their cost is not bounded by anything here.

Called by

1

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

What it touches

• optionoption read or writeget_option()called directly
• hookthird-party callbacksapply_filters()called directly
• querycontent queryget_user_by()called directly
• mailsends mailwp_mail()called directly
• cacheobject cachewp_cache_get()one call below wp_new_user_notification()
• serializeserialisationmaybe_unserialize()one call below wp_new_user_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 · 42 distinct outcomes

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

Hooks and filters fired · 4

4 hooks fire while wp_new_user_notification() runs, in this order:

1. 1
   apply_filters( wp_send_new_user_notification_to_admin )filterline 2302 (+26 into the body)

   Filters whether the admin is notified of a new user registration.

2. 2
   apply_filters( wp_new_user_notification_email_admin )filterline 2345 (+69 into the body)

   Filters the contents of the new user notification email sent to the site admin.

3. 3
   apply_filters( wp_send_new_user_notification_to_user )filterline 2367 (+91 into the body)

   Filters whether the user is notified of their new user registration.

4. 4
   apply_filters( wp_new_user_notification_email )filterline 2416 (+140 into the body)

   Filters the contents of the new user notification email sent to the new user.

Uses · 15

• _deprecated_argument()Marks a function argument as deprecated and inform when it has been used.
• get_userdata()Retrieves user info by user ID.
• wp_specialchars_decode()Converts a number of HTML entities into their special characters.
• get_option()Retrieves an option value based on an option name.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• 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_mail()Sends an email, similar to PHP's mail function.
• restore_previous_locale()Restores the translations according to the previous locale.

Used by · 1

• wp_send_new_user_notifications()Initiates email notifications related to the creation of new users.

Source code

View on Trac ↗View on GitHub ↗

2276	function wp_new_user_notification( $user_id, $deprecated = null, $notify = '' ) {2277		if ( null !== $deprecated ) {2278			_deprecated_argument( __FUNCTION__, '4.3.1' );2279		}2280 2281		// Accepts only 'user', 'admin' , 'both' or default '' as $notify.2282		if ( ! in_array( $notify, array( 'user', 'admin', 'both', '' ), true ) ) {2283			return;2284		}2285 2286		$user = get_userdata( $user_id );2287 2288		/*2289		 * The blogname option is escaped with esc_html() on the way into the database in sanitize_option().2290		 * We want to reverse this for the plain text arena of emails.2291		 */2292		$blogname = wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES );2293 2294		/**2295		 * Filters whether the admin is notified of a new user registration.2296		 *2297		 * @since 6.1.02298		 *2299		 * @param bool    $send Whether to send the email. Default true.2300		 * @param WP_User $user User object for new user.2301		 */2302		$send_notification_to_admin = apply_filters( 'wp_send_new_user_notification_to_admin', true, $user );2303 2304		if ( 'user' !== $notify && true === $send_notification_to_admin ) {2305 2306			$admin_user = get_user_by( 'email', get_option( 'admin_email' ) );2307 2308			if ( $admin_user ) {2309				$switched_locale = switch_to_user_locale( $admin_user->ID );2310			} else {2311				$switched_locale = switch_to_locale( get_locale() );2312			}2313 2314			/* translators: %s: Site title. */2315			$message = sprintf( __( 'New user registration on your site %s:' ), $blogname ) . "\r\n\r\n";2316			/* translators: %s: User login. */2317			$message .= sprintf( __( 'Username: %s' ), $user->user_login ) . "\r\n\r\n";2318			/* translators: %s: User email address. */2319			$message .= sprintf( __( 'Email: %s' ), $user->user_email ) . "\r\n";2320 2321			$wp_new_user_notification_email_admin = array(2322				'to'      => get_option( 'admin_email' ),2323				/* translators: New user registration notification email subject. %s: Site title. */2324				'subject' => __( '[%s] New User Registration' ),2325				'message' => $message,2326				'headers' => '',2327			);2328 2329			/**2330			 * Filters the contents of the new user notification email sent to the site admin.2331			 *2332			 * @since 4.9.02333			 *2334			 * @param array   $wp_new_user_notification_email_admin {2335			 *     Used to build wp_mail().2336			 *2337			 *     @type string $to      The intended recipient - site admin email address.2338			 *     @type string $subject The subject of the email.2339			 *     @type string $message The body of the email.2340			 *     @type string $headers The headers of the email.2341			 * }2342			 * @param WP_User $user     User object for new user.2343			 * @param string  $blogname The site title.2344			 */2345			$wp_new_user_notification_email_admin = apply_filters( 'wp_new_user_notification_email_admin', $wp_new_user_notification_email_admin, $user, $blogname );2346 2347			wp_mail(2348				$wp_new_user_notification_email_admin['to'],2349				wp_specialchars_decode( sprintf( $wp_new_user_notification_email_admin['subject'], $blogname ) ),2350				$wp_new_user_notification_email_admin['message'],2351				$wp_new_user_notification_email_admin['headers']2352			);2353 2354			if ( $switched_locale ) {2355				restore_previous_locale();

Changelog

Introduced in 2.0.0. One change between 6.7.7 and 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.1.0 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.