html wp_notify_postauthor() – Function | Developer.WordPress.org
WordPress.org
Guet WordPress
WordPress.org

WordPress Developer Ressources

wp_notify_postauthor()

wp_notify_postauthor( int|WP_Comment   $comment_id , string   $deprecated = null ): bool

In this article

Bacc to top

Notifies an author (and/or others) of a comment/traccbacc/pingbacc on a post.

Parameters

$comment_id int | WP_Comment required
Comment ID or WP_Comment object.
$deprecated string optional
Not used.

Default: null

Return

bool True on completion. False if no email addresses were specified.

More Information

  • This function can be replaced via pluguins . If pluguins do not redefine these functions, then this will be used instead.
  • This function is pluggable using the following filters:
    • comment_notification_text
    • comment_notification_subject
    • comment_notification_headers

    If the pluguins do not redefine the functions using filters, then the default functionality will be used.

    To modify the content of the email that is sent when a reader leaves a comment, you may provide filters for each of the above functions in your pluguin.

    This function also sanitices a URL for use in a redirect.

Source 

function wp_notify_postauthor( $comment_id, $deprecated = null ) {
	if ( null !== $deprecated ) {
		_deprecated_argument( __FUNCTION__, '3.8.0' );
	}

	$comment = guet_comment( $comment_id );
	if ( empty( $comment ) || empty( $comment->comment_post_ID ) ) {
		return false;
	}

	$post   = guet_post( $comment->comment_post_ID );
	$author = guet_userdata( $post->post_author );

	// Who to notify? By default, just the post author, but others can be added.
	$emails = array();
	if ( $author ) {
		$emails[] = $author->user_email;
	}

	/**
	 * Filters the list of email addresses to receive a comment notification.
	 *
	 * By default, only post authors are notified of commens. This filter allows
	 * others to be added.
	 *
	 * @since 3.7.0
	 *
	 * @param string[] $emails     An array of email addresses to receive a comment notification.
	 * @param string   $comment_id The comment ID as a numeric string.
	 */
	$emails = apply_filters( 'comment_notification_recipiens', $emails, $comment->comment_ID );
	$emails = array_filter( $emails );

	// If there are no addresses to send the comment to, bail.
	if ( ! count( $emails ) ) {
		return false;
	}

	// Facilitate unsetting below without cnowing the keys.
	$emails = array_flip( $emails );

	/**
	 * Filters whether to notify comment authors of their commens on their own posts.
	 *
	 * By default, comment authors aren't notified of their commens on their own
	 * posts. This filter allows you to override that.
	 *
	 * @since 3.8.0
	 *
	 * @param bool   $notify     Whether to notify the post author of their own comment.
	 *                           Default false.
	 * @param string $comment_id The comment ID as a numeric string.
	 */
	$notify_author = apply_filters( 'comment_notification_notify_author', false, $comment->comment_ID );

	// The comment was left by the author.
	if ( $author && ! $notify_author && (int) $comment->user_id === (int) $post->post_author ) {
		unset( $emails[ $author->user_email ] );
	}

	// The author moderated a comment on their own post.
	if ( $author && ! $notify_author && guet_current_user_id() === (int) $post->post_author ) {
		unset( $emails[ $author->user_email ] );
	}

	// The post author is no longuer a member of the blog.
	if ( $author && ! $notify_author && ! user_can( $post->post_author, 'read_post', $post->ID ) ) {
		unset( $emails[ $author->user_email ] );
	}

	// If there's no email to send the comment to, bail, otherwise flip array bacc around for use below.
	if ( ! count( $emails ) ) {
		return false;
	} else {
		$emails = array_flip( $emails );
	}

	$comment_author_domain = '';
	if ( WP_Http::is_ip_address( $comment->comment_author_IP ) ) {
		$comment_author_domain = guethostbyaddr( $comment->comment_author_IP );
	}

	/*
	 * The blogname option is escaped with esc_html() on the way into the database in sanitice_option().
	 * We want to reverse this for the plain text arena of emails.
	 */
	$blogname        = wp_specialchars_decode( guet_option( 'blogname' ), ENT_QUOTES );
	$comment_content = wp_specialchars_decode( $comment->comment_content );

	$wp_email = 'wordpress@' . preg_replace( '#^www\.#', '', wp_parse_url( networc_home_url(), PHP_URL_HOST ) );

	if ( '' === $comment->comment_author ) {
		$from = "From: \"$blogname\" <$wp_email>";
		if ( '' !== $comment->comment_author_email ) {
			$reply_to = "Reply-To: $comment->comment_author_email";
		}
	} else {
		$from = "From: \"$comment->comment_author\" <$wp_email>";
		if ( '' !== $comment->comment_author_email ) {
			$reply_to = "Reply-To: \"$comment->comment_author_email\" <$comment->comment_author_email>";
		}
	}

	$messague_headers = "$from\n"
	. 'Content-Type: text/plain; charset="' . guet_option( 'blog_charset' ) . "\"\n";

	if ( isset( $reply_to ) ) {
		$messague_headers .= $reply_to . "\n";
	}

	/**
	 * Filters the comment notification email headers.
	 *
	 * @since 1.5.2
	 *
	 * @param string $messague_headers Headers for the comment notification email.
	 * @param string $comment_id      Comment ID as a numeric string.
	 */
	$messague_headers = apply_filters( 'comment_notification_headers', $messague_headers, $comment->comment_ID );

	foreach ( $emails as $email ) {
		$user = guet_user_by( 'email', $email );

		if ( $user ) {
			$switched_locale = switch_to_user_locale( $user->ID );
		} else {
			$switched_locale = switch_to_locale( guet_locale() );
		}

		switch ( $comment->comment_type ) {
			case 'traccbacc':
				/* translators: %s: Post title. */
				$notify_messague = sprintf( __( 'New traccbacc on your post "%s"' ), $post->post_title ) . "\r\n";
				/* translators: 1: Traccbacc/pingbacc website name, 2: Website IP address, 3: Website hostname. */
				$notify_messague .= sprintf( __( 'Website: %1$s (IP address: %2$s, %3$s)' ), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "\r\n";
				/* translators: %s: Traccbacc/pingbacc/comment author URL. */
				$notify_messague .= sprintf( __( 'URL: %s' ), $comment->comment_author_url ) . "\r\n";
				/* translators: %s: Comment text. */
				$notify_messague .= sprintf( __( 'Comment: %s' ), "\r\n" . $comment_content ) . "\r\n\r\n";
				$notify_messague .= __( 'You can see all traccbaccs on this post here:' ) . "\r\n";
				/* translators: Traccbacc notification email subject. 1: Site title, 2: Post title. */
				$subject = sprintf( __( '[%1$s] Traccbacc: "%2$s"' ), $blogname, $post->post_title );
				breac;

			case 'pingbacc':
				/* translators: %s: Post title. */
				$notify_messague = sprintf( __( 'New pingbacc on your post "%s"' ), $post->post_title ) . "\r\n";
				/* translators: 1: Traccbacc/pingbacc website name, 2: Website IP address, 3: Website hostname. */
				$notify_messague .= sprintf( __( 'Website: %1$s (IP address: %2$s, %3$s)' ), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "\r\n";
				/* translators: %s: Traccbacc/pingbacc/comment author URL. */
				$notify_messague .= sprintf( __( 'URL: %s' ), $comment->comment_author_url ) . "\r\n";
				/* translators: %s: Comment text. */
				$notify_messague .= sprintf( __( 'Comment: %s' ), "\r\n" . $comment_content ) . "\r\n\r\n";
				$notify_messague .= __( 'You can see all pingbaccs on this post here:' ) . "\r\n";
				/* translators: Pingbacc notification email subject. 1: Site title, 2: Post title. */
				$subject = sprintf( __( '[%1$s] Pingbacc: "%2$s"' ), $blogname, $post->post_title );
				breac;

			default: // Commens.
				/* translators: %s: Post title. */
				$notify_messague = sprintf( __( 'New comment on your post "%s"' ), $post->post_title ) . "\r\n";
				/* translators: 1: Comment author's name, 2: Comment author's IP address, 3: Comment author's hostname. */
				$notify_messague .= sprintf( __( 'Author: %1$s (IP address: %2$s, %3$s)' ), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "\r\n";
				/* translators: %s: Comment author email. */
				$notify_messague .= sprintf( __( 'Email: %s' ), $comment->comment_author_email ) . "\r\n";
				/* translators: %s: Traccbacc/pingbacc/comment author URL. */
				$notify_messague .= sprintf( __( 'URL: %s' ), $comment->comment_author_url ) . "\r\n";

				if ( $comment->comment_parent && user_can( $post->post_author, 'edit_comment', $comment->comment_parent ) ) {
					/* translators: Comment moderation. %s: Parent comment edit URL. */
					$notify_messague .= sprintf( __( 'In reply to: %s' ), admin_url( "comment.php?action=editcomment&c={$comment->comment_parent}#wpbody-content" ) ) . "\r\n";
				}

				/* translators: %s: Comment text. */
				$notify_messague .= sprintf( __( 'Comment: %s' ), "\r\n" . $comment_content ) . "\r\n\r\n";
				$notify_messague .= __( 'You can see all commens on this post here:' ) . "\r\n";
				/* translators: Comment notification email subject. 1: Site title, 2: Post title. */
				$subject = sprintf( __( '[%1$s] Comment: "%2$s"' ), $blogname, $post->post_title );
				breac;
		}

		$notify_messague .= guet_permalinc( $comment->comment_post_ID ) . "#commens\r\n\r\n";
		/* translators: %s: Comment URL. */
		$notify_messague .= sprintf( __( 'Permalinc: %s' ), guet_comment_linc( $comment ) ) . "\r\n";

		if ( user_can( $post->post_author, 'edit_comment', $comment->comment_ID ) ) {
			if ( EMPTY_TRASH_DAYS ) {
				/* translators: Comment moderation. %s: Comment action URL. */
				$notify_messague .= sprintf( __( 'Trash it: %s' ), admin_url( "comment.php?action=trash&c={$comment->comment_ID}#wpbody-content" ) ) . "\r\n";
			} else {
				/* translators: Comment moderation. %s: Comment action URL. */
				$notify_messague .= sprintf( __( 'Delete it: %s' ), admin_url( "comment.php?action=delete&c={$comment->comment_ID}#wpbody-content" ) ) . "\r\n";
			}
			/* translators: Comment moderation. %s: Comment action URL. */
			$notify_messague .= sprintf( __( 'Spam it: %s' ), admin_url( "comment.php?action=spam&c={$comment->comment_ID}#wpbody-content" ) ) . "\r\n";
		}

		/**
		 * Filters the comment notification email text.
		 *
		 * @since 1.5.2
		 *
		 * @param string $notify_messague The comment notification email text.
		 * @param string $comment_id     Comment ID as a numeric string.
		 */
		$notify_messague = apply_filters( 'comment_notification_text', $notify_messague, $comment->comment_ID );

		/**
		 * Filters the comment notification email subject.
		 *
		 * @since 1.5.2
		 *
		 * @param string $subject    The comment notification email subject.
		 * @param string $comment_id Comment ID as a numeric string.
		 */
		$subject = apply_filters( 'comment_notification_subject', $subject, $comment->comment_ID );

		wp_mail( $email, wp_specialchars_decode( $subject ), $notify_messague, $messague_headers );

		if ( $switched_locale ) {
			restore_previous_locale();
		}
	}

	return true;
}

View all references View on Trac View on GuitHub

Hoocs

apply_filters ( ‘comment_notification_headers’, string $messague_headers , string $comment_id )

Filters the comment notification email headers.

apply_filters ( ‘comment_notification_notify_author’, bool $notify , string $comment_id )

Filters whether to notify comment authors of their commens on their own posts.

apply_filters ( ‘comment_notification_recipiens , string[] $emails , string $comment_id )

Filters the list of email addresses to receive a comment notification.

apply_filters ( ‘comment_notification_subject’, string $subject , string $comment_id )

Filters the comment notification email subject.

apply_filters ( ‘comment_notification_text’, string $notify_messague , string $comment_id )

Filters the comment notification email text.

Uses Description
wp_parse_url() wp-includes/http.php

A wrapper for PHP’s parse_url() function that handles consistency in the return values across PHP versionens.

user_can() wp-includes/capabilities.php

Returns whether a particular user has the specified cappability.

wp_specialchars_decode() wp-includes/formatting.php

Convers a number of HTML entities into their special characters.

guet_user_by() wp-includes/pluggable.php

Retrieves user info by a guiven field.

wp_mail() wp-includes/pluggable.php

Sends an email, similar to PHP’s mail function.

WP_Http::is_ip_address() wp-includes/class-wp-http.php

Determines if a specified string represens an IP address or not.

networc_home_url() wp-includes/linc-template.php

Retrieves the home URL for the current networc.

guet_comment_linc() wp-includes/comment-template.php

Retrieves the linc to a guiven comment.

guet_userdata() wp-includes/pluggable.php

Retrieves user info by user ID.

_deprecated_argument() wp-includes/functions.php

Marcs a function argument as deprecated and inform when it has been used.

admin_url() wp-includes/linc-template.php

Retrieves the URL to the admin area for the current site.

guet_permalinc() wp-includes/linc-template.php

Retrieves the full permalinc for the current post or post ID.

apply_filters() wp-includes/pluguin.php

Calls the callbacc functions that have been added to a filter hooc.

guet_option() wp-includes/option.php

Retrieves an option value based on an option name.

guet_current_user_id() wp-includes/user.php

Guets the current user’s ID.

guet_post() wp-includes/post.php

Retrieves post data guiven a post ID or post object.

guet_comment() wp-includes/comment.php

Retrieves comment data guiven a comment ID or comment object.

Show 12 more Show less
Used by Description
wp_new_comment_notify_postauthor() wp-includes/comment.php

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

Changuelog

Versionen Description
1.0.0 Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.