wp_new_comment_notify_postauthor( int $comment_id ): bool
- Since
- 4.4.0, 7.1.0
- Source
wp-includes/comment.php:2534
Description
Uses the 'notify_post_author' filter to determine whether the post author should be notified when a new comment is added, overriding site setting.
Compatibility
- WordPress
- since 7.1.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$comment_idint- Comment ID.
Return value
bool- True on success, false on failure.
Performance profile
How much work a call to wp_new_comment_notify_postauthor() 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
- Scaling
- Constant
- Instructions
- 8–31
- Plugin surface
- 1 hook
- Called by
- 1
Sends mail via wp_notify_postauthor().
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 41.
Third-party callbacks on 'notify_post_author' run inside this call, and their cost is not bounded by anything here.
1 place in core call this, so the cost is paid more often than your own code shows.
What it touches
- optionoption read or write
get_option()called directly - hookthird-party callbacks
apply_filters()called directly - mailsends mail
wp_notify_postauthor()called directly - cacheobject cache
wp_cache_get()one call below wp_new_comment_notify_postauthor() - serializeserialisation
maybe_unserialize()one call below wp_new_comment_notify_postauthor() - querycontent query
get_post()one call below wp_new_comment_notify_postauthor()
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_new_comment_notify_postauthor() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!($comment instanceof) | 8 | get_comment() |
$comment instanceof | 26 | get_comment(), apply_filters() |
$comment instanceof | 27–28 | get_comment(), get_option(), apply_filters() |
$comment instanceof | 29 | get_comment(), apply_filters(), wp_notify_postauthor() |
$comment instanceof | 30–31 | get_comment(), get_option(), apply_filters(), wp_notify_postauthor() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 41 instructions, 8–31 executed per call, 4 branches. The work does not change between versions.
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Hooks and filters fired · 1
One hook fires while wp_new_comment_notify_postauthor() runs, in this order:
- apply_filters( notify_post_author )filterline 2567 (+33 into the body)
Filters whether to send the post author new comment and note notification emails, overriding the site settings and defaults. By default, notifications are sent for all notes and for approved comments.
Uses · 4
- get_comment()Retrieves comment data given a comment ID or comment object.
- 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.
- wp_notify_postauthor()Notifies an author (and/or others) of a comment/trackback/pingback on a post.
Used by · 1
- wp_new_comment_via_rest_notify_postauthor()Send a notification to the post author when a new note is added via the REST API.
Source code
function wp_new_comment_notify_postauthor( $comment_id ) { $comment = get_comment( $comment_id ); if ( ! ( $comment instanceof WP_Comment ) ) { return false; } $comment_id = (int) $comment->comment_ID; $is_note = ( 'note' === $comment->comment_type ); /* * Determine the default notification behavior. Notes are eligible regardless * of approval status, based on the 'wp_notes_notify' option. Other comments * are only eligible once approved, based on the 'comments_notify' option. */ if ( $is_note ) { $maybe_notify = (bool) get_option( 'wp_notes_notify', 1 ); } elseif ( '1' !== $comment->comment_approved ) { $maybe_notify = false; } else { $maybe_notify = (bool) get_option( 'comments_notify' ); } /** * Filters whether to send the post author new comment and note notification emails, * overriding the site settings and defaults. By default, notifications are sent for * all notes and for approved comments. * * @since 4.4.0 * @since 7.1.0 Comment approval status is checked before this filter, * and the filter no longer fires for invalid comment IDs. * * @param bool $maybe_notify Whether to notify the post author about the new comment. * @param int $comment_id The ID of the comment for the notification. */ $maybe_notify = apply_filters( 'notify_post_author', $maybe_notify, $comment_id ); /* * wp_notify_postauthor() checks if notifying the author of their own comment. * By default, it won't, but filters can override this. */ if ( ! $maybe_notify ) { return false; } return wp_notify_postauthor( $comment_id );}Changelog
Introduced in 4.4.0. Unchanged from 6.7.7 through 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/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.