ClassicPress logo
Skip to content
Filter by type:
Browse: Home / Functions / wp_new_comment_notify_postauthor()

wp_new_comment_notify_postauthor( int $comment_ID )

Send a notification of a new comment to the post author.


Parameters

$comment_ID

(int) (Required) Comment ID.


Return

(bool) True on success, false on failure.


Source

File: wp-includes/comment.php

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 WP-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 );
}

Expand Source Code View on GitHub


Related

Uses

Uses
Uses Description
wp-includes/pluggable.php: wp_notify_postauthor()

Notify an author (and/or others) of a comment/trackback/pingback on a post.

wp-includes/comment.php: notify_post_author

Filters whether to send the post author new comment notification emails, overriding the site setting.

wp-includes/comment.php: get_comment()

Retrieves comment data given a comment ID or comment object.

wp-includes/plugin.php: apply_filters()

Call the functions added to a filter hook.

wp-includes/option.php: get_option()

Retrieves an option value based on an option name.


Changelog

Changelog
Version Description
WP-4.4.0 Introduced. Uses the 'notify_post_author' filter to determine whether the post author should be notified when a new comment is added, overriding site setting.
ClassicPress Documentation • Made with ClassicPress
Privacy Policy