wp_notify_postauthor()

💡 云策文档标注

概述

wp_notify_postauthor() 是 WordPress 核心函数，用于在文章有评论、trackback 或 pingback 时，通过电子邮件通知作者或其他指定人员。该函数是可插拔的，允许通过插件或过滤器自定义通知行为。

关键要点

函数参数：接受 $comment_id（评论 ID 或 WP_Comment 对象）和已弃用的 $deprecated 参数。
返回值：成功时返回 true，若无指定电子邮件地址则返回 false。
可插拔性：可通过插件重写此函数，或使用过滤器（如 comment_notification_text、comment_notification_subject、comment_notification_headers）修改邮件内容。
通知逻辑：默认仅通知文章作者，但可通过 comment_notification_recipients 过滤器添加其他收件人，并包含多种条件判断（如作者是否通知自己的评论）。
邮件内容：根据评论类型（comment、trackback、pingback、note）生成不同的邮件主题和正文，支持本地化切换。

代码示例

// 基本用法示例：通知文章作者有新评论
$comment_id = 123;
$result = wp_notify_postauthor($comment_id);
if ($result) {
    echo '通知发送成功';
} else {
    echo '通知发送失败或无收件人';
}

注意事项

函数已弃用 $deprecated 参数，自 3.8.0 版本起不再使用，调用时建议忽略。
邮件发送依赖于 wp_mail() 函数，需确保服务器邮件配置正确。
通过过滤器自定义时，注意保持邮件格式和编码一致性，避免破坏通知功能。

📄 原文内容

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

Parameters

$comment_idint|WP_Commentrequired: Comment ID or WP_Comment object.
$deprecatedstringoptional: Not used.

Default:null

Return

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

More Information

This function can be replaced via plugins. If plugins 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 plugins 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 plugin.

This function also sanitizes 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 = get_comment( $comment_id );
	if ( empty( $comment ) || empty( $comment->comment_post_ID ) ) {
		return false;
	}

	$post   = get_post( $comment->comment_post_ID );
	$author = get_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 comments. 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_recipients', $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 knowing the keys.
	$emails = array_flip( $emails );

	/**
	 * Filters whether to notify comment authors of their comments on their own posts.
	 *
	 * By default, comment authors aren't notified of their comments 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 && get_current_user_id() === (int) $post->post_author ) {
		unset( $emails[ $author->user_email ] );
	}

	// The post author is no longer 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 back 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 = gethostbyaddr( $comment->comment_author_IP );
	}

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

	$wp_email = 'wordpress@' . preg_replace( '#^www.#', '', wp_parse_url( network_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>";
		}
	}

	$message_headers = "$fromn"
	. 'Content-Type: text/plain; charset="' . get_option( 'blog_charset' ) . ""n";

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

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

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

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

		switch ( $comment->comment_type ) {
			case 'trackback':
				/* translators: %s: Post title. */
				$notify_message = sprintf( __( 'New trackback on your post "%s"' ), $post->post_title ) . "rn";
				/* translators: 1: Trackback/pingback website name, 2: Website IP address, 3: Website hostname. */
				$notify_message .= sprintf( __( 'Website: %1$s (IP address: %2$s, %3$s)' ), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "rn";
				/* translators: %s: Trackback/pingback/comment author URL. */
				$notify_message .= sprintf( __( 'URL: %s' ), $comment->comment_author_url ) . "rn";
				/* translators: %s: Comment text. */
				$notify_message .= sprintf( __( 'Comment: %s' ), "rn" . $comment_content ) . "rnrn";
				$notify_message .= __( 'You can see all trackbacks on this post here:' ) . "rn";
				/* translators: Trackback notification email subject. 1: Site title, 2: Post title. */
				$subject = sprintf( __( '[%1$s] Trackback: "%2$s"' ), $blogname, $post->post_title );
				break;

			case 'pingback':
				/* translators: %s: Post title. */
				$notify_message = sprintf( __( 'New pingback on your post "%s"' ), $post->post_title ) . "rn";
				/* translators: 1: Trackback/pingback website name, 2: Website IP address, 3: Website hostname. */
				$notify_message .= sprintf( __( 'Website: %1$s (IP address: %2$s, %3$s)' ), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "rn";
				/* translators: %s: Trackback/pingback/comment author URL. */
				$notify_message .= sprintf( __( 'URL: %s' ), $comment->comment_author_url ) . "rn";
				/* translators: %s: Comment text. */
				$notify_message .= sprintf( __( 'Comment: %s' ), "rn" . $comment_content ) . "rnrn";
				$notify_message .= __( 'You can see all pingbacks on this post here:' ) . "rn";
				/* translators: Pingback notification email subject. 1: Site title, 2: Post title. */
				$subject = sprintf( __( '[%1$s] Pingback: "%2$s"' ), $blogname, $post->post_title );
				break;

			case 'note':
				/* translators: %s: Post title. */
				$notify_message = sprintf( __( 'New note on your post "%s"' ), $post->post_title ) . "rn";
				/* translators: 1: Note author's name, 2: Note author's IP address, 3: Note author's hostname. */
				$notify_message .= sprintf( __( 'Author: %1$s (IP address: %2$s, %3$s)' ), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "rn";
				/* translators: %s: Note author email. */
				$notify_message .= sprintf( __( 'Email: %s' ), $comment->comment_author_email ) . "rn";
				/* translators: %s: Note text. */
				$notify_message .= sprintf( __( 'Note: %s' ), "rn" . ( empty( $comment_content ) ? __( 'resolved/reopened' ) : $comment_content ) ) . "rnrn";
				$notify_message .= __( 'You can see all notes on this post here:' ) . "rn";
				/* translators: Note notification email subject. 1: Site title, 2: Post title. */
				$subject = sprintf( __( '[%1$s] Note: "%2$s"' ), $blogname, $post->post_title );
				break;

			default: // Comments.
				/* translators: %s: Post title. */
				$notify_message = sprintf( __( 'New comment on your post "%s"' ), $post->post_title ) . "rn";
				/* translators: 1: Comment author's name, 2: Comment author's IP address, 3: Comment author's hostname. */
				$notify_message .= sprintf( __( 'Author: %1$s (IP address: %2$s, %3$s)' ), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "rn";
				/* translators: %s: Comment author email. */
				$notify_message .= sprintf( __( 'Email: %s' ), $comment->comment_author_email ) . "rn";
				/* translators: %s: Trackback/pingback/comment author URL. */
				$notify_message .= sprintf( __( 'URL: %s' ), $comment->comment_author_url ) . "rn";

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

				/* translators: %s: Comment text. */
				$notify_message .= sprintf( __( 'Comment: %s' ), "rn" . $comment_content ) . "rnrn";
				$notify_message .= __( 'You can see all comments on this post here:' ) . "rn";
				/* translators: Comment notification email subject. 1: Site title, 2: Post title. */
				$subject = sprintf( __( '[%1$s] Comment: "%2$s"' ), $blogname, $post->post_title );
				break;
		}

		/* translators: %s: Comment URL. */
		if ( 'note' === $comment->comment_type ) {
			$notify_message .= get_edit_post_link( $comment->comment_post_ID, 'url' ) . "rn";
		} else {
			$notify_message .= get_permalink( $comment->comment_post_ID ) . "#commentsrnrn";
			$notify_message .= sprintf( __( 'Permalink: %s' ), get_comment_link( $comment ) ) . "rn";
		}

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

		/**
		 * Filters the comment notification email text.
		 *
		 * @since 1.5.2
		 *
		 * @param string $notify_message The comment notification email text.
		 * @param string $comment_id     Comment ID as a numeric string.
		 */
		$notify_message = apply_filters( 'comment_notification_text', $notify_message, $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_message, $message_headers );

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

	return true;
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘comment_notification_headers’, string $message_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 comments on their own posts.
apply_filters( ‘comment_notification_recipients’, 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_message, string $comment_id ): Filters the comment notification email text.

Uses	Description
switch_to_user_locale()`wp-includes/l10n.php`	Switches the translations according to the given user’s locale.
restore_previous_locale()`wp-includes/l10n.php`	Restores the translations according to the previous locale.
switch_to_locale()`wp-includes/l10n.php`	Switches the translations according to the given locale.
wp_parse_url()`wp-includes/http.php`	A wrapper for PHP’s parse_url() function that handles consistency in the return values across PHP versions.
user_can()`wp-includes/capabilities.php`	Returns whether a particular user has the specified capability.
get_locale()`wp-includes/l10n.php`	Retrieves the current locale.
wp_specialchars_decode()`wp-includes/formatting.php`	Converts a number of HTML entities into their special characters.
get_user_by()`wp-includes/pluggable.php`	Retrieves user info by a given 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 represents an IP address or not.
network_home_url()`wp-includes/link-template.php`	Retrieves the home URL for the current network.
get_edit_post_link()`wp-includes/link-template.php`	Retrieves the edit post link for post.
get_comment_link()`wp-includes/comment-template.php`	Retrieves the link to a given comment.
__()`wp-includes/l10n.php`	Retrieves the translation of $text.
get_userdata()`wp-includes/pluggable.php`	Retrieves user info by user ID.
_deprecated_argument()`wp-includes/functions.php`	Marks a function argument as deprecated and inform when it has been used.
admin_url()`wp-includes/link-template.php`	Retrieves the URL to the admin area for the current site.
get_permalink()`wp-includes/link-template.php`	Retrieves the full permalink for the current post or post ID.
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_current_user_id()`wp-includes/user.php`	Gets the current user’s ID.
get_post()`wp-includes/post.php`	Retrieves post data given a post ID or post object.
get_comment()`wp-includes/comment.php`	Retrieves comment data given a comment ID or comment object.

Show 18 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.

Changelog

Version	Description
1.0.0	Introduced.

云策 WordPress 开发者社区

函数文档

wp_notify_postauthor()

概述

关键要点

代码示例

注意事项

Parameters

Return

More Information

Source

Hooks

Changelog

函数文档

概述

关键要点

代码示例

注意事项

Parameters

Return

More Information

Source

Hooks

Related

Changelog