wp_send_note_notification( WP_User $user, WP_Comment $comment, WP_Post|null $post ): bool

Description

Compatibility

Present in 1 of the 5 tracked releases, added in 7.1.0, and compiles on PHP 7.4 through 8.6-dev.

Parameters

$userWP_User

The recipient.

$commentWP_Comment

The note that triggered the notification.

$postWP_Post|null

The post the note belongs to.

Return value

bool

Whether the email was accepted for delivery by wp_mail().

Performance profile

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

79–121

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

Plugin surface

None

Nothing here hands control to plugin code.

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
• mailsends mailwp_mail()called directly
• hookthird-party callbacksapply_filters()one call below wp_send_note_notification()
• querycontent queryget_post()one call below wp_send_note_notification()
• cacheobject cachewp_cache_get()one call below wp_send_note_notification()
• serializeserialisationmaybe_unserialize()one call below wp_send_note_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 · 32 distinct outcomes

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

Uses · 12

• switch_to_user_locale()Switches the translations according to the given user's locale.
• wp_specialchars_decode()Converts a number of HTML entities into their special characters.
• get_bloginfo()Retrieves information about the current site.
• get_the_title()Retrieves the post title.
• __()Retrieves the translation of $text.
• wp_strip_all_tags()Properly strips all HTML tags including 'script' and 'style'.
• get_current_user_id()Gets the current user's ID.
• wp_set_current_user()Changes the current user by ID or name.
• get_edit_post_link()Retrieves the edit post link for post.
• get_option()Retrieves an option value based on an option name.
• 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_notify_note_mentions()Notifies mentioned users about a new note.

Source code

View on Trac ↗View on GitHub ↗

2727function wp_send_note_notification( WP_User $user, WP_Comment $comment, ?WP_Post $post ): bool {2728	$switched_locale = switch_to_user_locale( $user->ID );2729 2730	/*2731	 * The site title and the post title are escaped on the way into the database,2732	 * and note content is stored as HTML. Both are reversed once here for the2733	 * plain text arena of emails. Decoding a second time would go too far and2734	 * resolve entities the author meant to be read literally.2735	 */2736	$blogname    = wp_specialchars_decode( get_bloginfo( 'name', 'display' ), ENT_QUOTES );2737	$post_title  = $post ? wp_specialchars_decode( get_the_title( $post ), ENT_QUOTES ) : '';2738	$author_name = $comment->comment_author ? $comment->comment_author : __( 'Someone' );2739	$content     = wp_specialchars_decode( wp_strip_all_tags( $comment->comment_content ) );2740 2741	/*2742	 * The rest of the message is composed for the recipient, and so is the editor2743	 * link: get_edit_post_link() answers for whoever is current, which here is the2744	 * note's author over REST and nobody at all under WP-Cron.2745	 */2746	$edit_link = '';2747	if ( $post ) {2748		$previous_user_id = get_current_user_id();2749		wp_set_current_user( $user->ID );2750		$edit_link = (string) get_edit_post_link( $post->ID, 'url' );2751		wp_set_current_user( $previous_user_id );2752	}2753 2754	/* translators: 1: Note author's name, 2: Post title. */2755	$message = sprintf( __( '%1$s mentioned you in a note on "%2$s".' ), $author_name, $post_title );2756	/* translators: Note mention notification email subject. 1: Site title, 2: Post title. */2757	$subject = sprintf( __( '[%1$s] You were mentioned in a note on "%2$s"' ), $blogname, $post_title );2758 2759	$lines = array( $message, '' );2760	if ( '' !== $content ) {2761		$lines[] = $content;2762	}2763	if ( $edit_link ) {2764		$lines[] = '';2765		$lines[] = __( 'Edit This' ) . ': ' . $edit_link;2766	}2767 2768	// Declared explicitly so a filtered default cannot turn the message into HTML.2769	$headers = 'Content-Type: text/plain; charset="' . get_option( 'blog_charset' ) . '"';2770 2771	$sent = wp_mail( $user->user_email, $subject, implode( "\n", $lines ), $headers );2772 2773	if ( $switched_locale ) {2774		restore_previous_locale();2775	}2776 2777	return $sent;2778}

Changelog

Introduced in 7.1.0.

Signature, return type and hooks compared across 1 parsed release.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/comment.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.