wp_notify_postauthor()过滤用于重定向的URL

目录

描述

译文

该函数可由插件代替。若插件无法重新定义函数,则使用该函数。

该函数过滤用于重定向的URL。

原文

This function is responsible for sending comment notification emails to the post author whenever a reader leaves a comment. It is pluggable and can be customized using plugins.

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.

wp_notify_postauthor() 描述

用法

<?php wp_notify_postauthor$comment_id ?>

wp_notify_postauthor() 用法

参数

$comment_id

(integer) (必填) Comment ID

默认值: None

$deprecated

(string) (可选) Deprecated in Version 3.8 and should no longer be used. The comment type either 'comment' (default), 'trackback', or 'pingback'

默认值: ''

wp_notify_postauthor() 参数

返回值

(boolean) 

False if user email does not exist. True on completion.

wp_notify_postauthor() 返回值

注意

  • This function can be replaced via plugins. If plugins do not redefine these functions, then this will be used instead.
  • 使用到: apply_filters() 调用 'allowed_redirect_hosts' on an array containing WordPress host string and $location host string.

wp_notify_postauthor() 注意

历史

  • 3.8.0: The comment $comment_type parameter was deprecated. See ticket #17862.
  • 添加于 版本: 1.0.0

wp_notify_postauthor() 历史

源文件

wp_notify_postauthor() 函数的代码位于 wp-includes/pluggable.php.

/* ----------------------------------
 * wordpress之魂 © http://wphun.com
 * ---------------------------------- */
/**
 * Notify an author (and/or others) of a comment/trackback/pingback on a post.
 *
 * @since 1.0.0
 *
 * @param int    $comment_id Comment ID
 * @param string $deprecated Not used
 * @return bool True on completion. False if no email addresses were specified.
 */
function wp_notify_postauthor( $comment_id, $deprecated = null ) {
	if ( null !== $deprecated ) {
		_deprecated_argument( __FUNCTION__, '3.8' );
	}

	$comment = get_comment( $comment_id );
	if ( empty( $comment ) )
		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;
	}

	/**
	 * Filter 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 array $emails     An array of email addresses to receive a comment notification.
	 * @param int   $comment_id The comment ID.
	 */
	$emails = apply_filters( 'comment_notification_recipients', $emails, $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 );

	/**
	 * Filter 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 int  $comment_id The comment ID.
	 */
	$notify_author = apply_filters( 'comment_notification_notify_author', false, $comment_id );

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

	// The author moderated a comment on their own post
	if ( $author && ! $notify_author && $post->post_author == get_current_user_id() ) {
		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 = @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);

	switch ( $comment->comment_type ) {
		case 'trackback':
			$notify_message  = sprintf( __( 'New trackback on your post "%s"' ), $post->post_title ) . "
";
			/* translators: 1: website name, 2: website IP, 3: website hostname */
			$notify_message .= sprintf( __('Website: %1$s (IP: %2$s, %3$s)'), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "
";
			$notify_message .= sprintf( __( 'URL: %s' ), $comment->comment_author_url ) . "
";
			$notify_message .= sprintf( __( 'Comment: %s' ), "
" . $comment->comment_content ) . "

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

";
			$notify_message .= __( 'You can see all pingbacks on this post here:' ) . "
";
			/* translators: 1: blog name, 2: post title */
			$subject = sprintf( __('[%1$s] Pingback: "%2$s"'), $blogname, $post->post_title );
			break;
		default: // Comments
			$notify_message  = sprintf( __( 'New comment on your post "%s"' ), $post->post_title ) . "
";
			/* translators: 1: comment author, 2: author IP, 3: author domain */
			$notify_message .= sprintf( __( 'Author: %1$s (IP: %2$s, %3$s)' ), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "
";
			$notify_message .= sprintf( __( 'E-mail: %s' ), $comment->comment_author_email ) . "
";
			$notify_message .= sprintf( __( 'URL: %s' ), $comment->comment_author_url ) . "
";
			$notify_message .= sprintf( __('Comment: %s' ), "
" . $comment->comment_content ) . "

";
			$notify_message .= __( 'You can see all comments on this post here:' ) . "
";
			/* translators: 1: blog name, 2: post title */
			$subject = sprintf( __('[%1$s] Comment: "%2$s"'), $blogname, $post->post_title );
			break;
	}
	$notify_message .= get_permalink($comment->comment_post_ID) . "#comments

";
	$notify_message .= sprintf( __('Permalink: %s'), get_comment_link( $comment_id ) ) . "
";

	if ( user_can( $post->post_author, 'edit_comment', $comment_id ) ) {
		if ( EMPTY_TRASH_DAYS )
			$notify_message .= sprintf( __('Trash it: %s'), admin_url("comment.php?action=trash&c=$comment_id") ) . "
";
		else
			$notify_message .= sprintf( __('Delete it: %s'), admin_url("comment.php?action=delete&c=$comment_id") ) . "
";
		$notify_message .= sprintf( __('Spam it: %s'), admin_url("comment.php?action=spam&c=$comment_id") ) . "
";
	}

	$wp_email = 'wordpress@' . preg_replace('#^www.#', '', strtolower($_SERVER['SERVER_NAME']));

	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 = "$from
"
		. "Content-Type: text/plain; charset="" . get_option('blog_charset') . ""
";

	if ( isset($reply_to) )
		$message_headers .= $reply_to . "
";

	/**
	 * Filter the comment notification email text.
	 *
	 * @since 1.5.2
	 *
	 * @param string $notify_message The comment notification email text.
	 * @param int    $comment_id     Comment ID.
	 */
	$notify_message = apply_filters( 'comment_notification_text', $notify_message, $comment_id );

	/**
	 * Filter the comment notification email subject.
	 *
	 * @since 1.5.2
	 *
	 * @param string $subject    The comment notification email subject.
	 * @param int    $comment_id Comment ID.
	 */
	$subject = apply_filters( 'comment_notification_subject', $subject, $comment_id );

	/**
	 * Filter the comment notification email headers.
	 *
	 * @since 1.5.2
	 *
	 * @param string $message_headers Headers for the comment notification email.
	 * @param int    $comment_id      Comment ID.
	 */
	$message_headers = apply_filters( 'comment_notification_headers', $message_headers, $comment_id );

	foreach ( $emails as $email ) {
		@wp_mail( $email, wp_specialchars_decode( $subject ), $notify_message, $message_headers );
	}

	return true;
}
endif;

if ( !function_exists('wp_notify_moderator') ) :

wp_notify_postauthor() 源文件