On this page
wp_new_comment_notify_postauthor( int $comment_ID ): bool
Sends a notification of a new comment to the post author.
Parameters
$comment_IDint Required-
Comment ID.
Return
bool True on success, false on failure.
Source
File: wp-includes/comment.php. View all references
function wp_new_comment_notify_postauthor( $comment_ID ) {
$comment = get_comment( $comment_ID );
$maybe_notify = get_option( 'comments_notify' );
/**
* Filters whether to send the post author new comment notification emails,
* overriding the site setting.
*
* @since 4.4.0
*
* @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;
}
// Only send notifications for approved comments.
if ( ! isset( $comment->comment_approved ) || '1' != $comment->comment_approved ) {
return false;
}
return wp_notify_postauthor( $comment_ID );
}
Hooks
- apply_filters( 'notify_post_author',
bool $maybe_notify ,int $comment_ID ) -
Filters whether to send the post author new comment notification emails, overriding the site setting.
Related
Uses
| Uses | Description |
|---|---|
| wp_notify_postauthor() wp-includes/pluggable.php | Notifies an author (and/or others) of a comment/trackback/pingback on a post. |
| apply_filters() wp-includes/plugin.php | Calls the callback functions that have been added to a filter hook. |
| get_option() wp-includes/option.php | Retrieves an option value based on an option name. |
| get_comment() wp-includes/comment.php | Retrieves comment data given a comment ID or comment object. |
Changelog
| Version | Description |
|---|---|
| 4.4.0 | Introduced. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/wp_new_comment_notify_postauthor