云策 WordPress 开发者社区

函数文档

wp_notify_moderator()

查看官方原文 ↗
💡 云策文档标注

概述

wp_notify_moderator() 是 WordPress 核心函数，用于向站点管理员发送新评论待审核的通知邮件。该函数根据评论类型（如评论、trackback、pingback）生成邮件内容，并支持通过多个过滤器钩子进行自定义。

关键要点

  • 函数参数：接受一个必需的整数参数 $comment_id，表示评论 ID。
  • 返回值：始终返回 true。
  • 通知控制：通过 'moderation_notify' 选项和 notify_moderator 过滤器决定是否发送通知。
  • 收件人：默认包括管理员邮箱，如果文章作者有编辑评论权限且邮箱不同，也会添加。
  • 邮件内容：根据评论类型（评论、trackback、pingback）生成不同消息，包含评论详情、审核链接和待审核评论数。
  • 过滤器钩子：提供 comment_moderation_recipients、comment_moderation_headers、comment_moderation_text、comment_moderation_subject 等钩子用于自定义收件人、邮件头、内容和主题。
  • 本地化支持：使用 switch_to_user_locale() 和 switch_to_locale() 切换邮件语言环境。

代码示例

function wp_notify_moderator( $comment_id ) {
    global $wpdb;
    $maybe_notify = get_option( 'moderation_notify' );
    $maybe_notify = apply_filters( 'notify_moderator', $maybe_notify, $comment_id );
    if ( ! $maybe_notify ) {
        return true;
    }
    // 获取评论、文章和用户数据
    $comment = get_comment( $comment_id );
    $post    = get_post( $comment->comment_post_ID );
    $user    = get_userdata( $post->post_author );
    $emails = array( get_option( 'admin_email' ) );
    if ( $user && user_can( $user->ID, 'edit_comment', $comment_id ) && ! empty( $user->user_email ) ) {
        if ( 0 !== strcasecmp( $user->user_email, get_option( 'admin_email' ) ) ) {
            $emails[] = $user->user_email;
        }
    }
    // 生成邮件内容并发送
    $emails = apply_filters( 'comment_moderation_recipients', $emails, $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':
                // trackback 消息生成
                break;
            case 'pingback':
                // pingback 消息生成
                break;
            default:
                // 普通评论消息生成
                break;
        }
        // 添加审核链接和待审核评论数
        $subject = sprintf( __( '[%1$s] Please moderate: "%2$s"' ), $blogname, $post->post_title );
        $notify_message = apply_filters( 'comment_moderation_text', $notify_message, $comment_id );
        $subject = apply_filters( 'comment_moderation_subject', $subject, $comment_id );
        wp_mail( $email, wp_specialchars_decode( $subject ), $notify_message, $message_headers );
        if ( $switched_locale ) {
            restore_previous_locale();
        }
    }
    return true;
}

注意事项

  • 函数依赖于 WordPress 的邮件发送功能 wp_mail()，需确保服务器邮件配置正确。
  • 通过过滤器钩子可以灵活定制通知行为，如修改收件人列表或邮件内容。
  • 本地化处理确保邮件语言与用户或站点设置一致。
📄 原文内容

Notifies the moderator of the site about a new comment that is awaiting approval.

Parameters

$comment_idintrequired
Comment ID.

Return

true Always returns true.

Source

function wp_notify_moderator( $comment_id ) {
	global $wpdb;

	$maybe_notify = get_option( 'moderation_notify' );

	/**
	 * Filters whether to send the site moderator email notifications, overriding the site setting.
	 *
	 * @since 4.4.0
	 *
	 * @param bool $maybe_notify Whether to notify blog moderator.
	 * @param int  $comment_id   The ID of the comment for the notification.
	 */
	$maybe_notify = apply_filters( 'notify_moderator', $maybe_notify, $comment_id );

	if ( ! $maybe_notify ) {
		return true;
	}

	$comment = get_comment( $comment_id );
	$post    = get_post( $comment->comment_post_ID );
	$user    = get_userdata( $post->post_author );
	// Send to the administration and to the post author if the author can modify the comment.
	$emails = array( get_option( 'admin_email' ) );
	if ( $user && user_can( $user->ID, 'edit_comment', $comment_id ) && ! empty( $user->user_email ) ) {
		if ( 0 !== strcasecmp( $user->user_email, get_option( 'admin_email' ) ) ) {
			$emails[] = $user->user_email;
		}
	}

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

	$comments_waiting = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->comments WHERE comment_approved = '0'" );

	/*
	 * 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 );

	$message_headers = '';

	/**
	 * Filters the list of recipients for comment moderation emails.
	 *
	 * @since 3.7.0
	 *
	 * @param string[] $emails     List of email addresses to notify for comment moderation.
	 * @param int      $comment_id Comment ID.
	 */
	$emails = apply_filters( 'comment_moderation_recipients', $emails, $comment_id );

	/**
	 * Filters the comment moderation email headers.
	 *
	 * @since 2.8.0
	 *
	 * @param string $message_headers Headers for the comment moderation email.
	 * @param int    $comment_id      Comment ID.
	 */
	$message_headers = apply_filters( 'comment_moderation_headers', $message_headers, $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( __( 'A new trackback on the post "%s" is waiting for your approval' ), $post->post_title ) . "rn";
				$notify_message .= get_permalink( $comment->comment_post_ID ) . "rnrn";
				/* 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";
				$notify_message .= __( 'Trackback excerpt: ' ) . "rn" . $comment_content . "rnrn";
				break;

			case 'pingback':
				/* translators: %s: Post title. */
				$notify_message  = sprintf( __( 'A new pingback on the post "%s" is waiting for your approval' ), $post->post_title ) . "rn";
				$notify_message .= get_permalink( $comment->comment_post_ID ) . "rnrn";
				/* 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";
				$notify_message .= __( 'Pingback excerpt: ' ) . "rn" . $comment_content . "rnrn";
				break;

			default: // Comments.
				/* translators: %s: Post title. */
				$notify_message  = sprintf( __( 'A new comment on the post "%s" is waiting for your approval' ), $post->post_title ) . "rn";
				$notify_message .= get_permalink( $comment->comment_post_ID ) . "rnrn";
				/* 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 ) {
					/* 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";
				break;
		}

		/* translators: Comment moderation. %s: Comment action URL. */
		$notify_message .= sprintf( __( 'Approve it: %s' ), admin_url( "comment.php?action=approve&c;={$comment_id}#wpbody-content" ) ) . "rn";

		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_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_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_id}#wpbody-content" ) ) . "rn";

		$notify_message .= sprintf(
			/* translators: Comment moderation. %s: Number of comments awaiting approval. */
			_n(
				'Currently %s comment is waiting for approval. Please visit the moderation panel:',
				'Currently %s comments are waiting for approval. Please visit the moderation panel:',
				$comments_waiting
			),
			number_format_i18n( $comments_waiting )
		) . "rn";
		$notify_message .= admin_url( 'edit-comments.php?comment_status=moderated#wpbody-content' ) . "rn";

		/* translators: Comment moderation notification email subject. 1: Site title, 2: Post title. */
		$subject = sprintf( __( '[%1$s] Please moderate: "%2$s"' ), $blogname, $post->post_title );

		/**
		 * Filters the comment moderation email text.
		 *
		 * @since 1.5.2
		 *
		 * @param string $notify_message Text of the comment moderation email.
		 * @param int    $comment_id     Comment ID.
		 */
		$notify_message = apply_filters( 'comment_moderation_text', $notify_message, $comment_id );

		/**
		 * Filters the comment moderation email subject.
		 *
		 * @since 1.5.2
		 *
		 * @param string $subject    Subject of the comment moderation email.
		 * @param int    $comment_id Comment ID.
		 */
		$subject = apply_filters( 'comment_moderation_subject', $subject, $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_moderation_headers’, string $message_headers, int $comment_id )

Filters the comment moderation email headers.

apply_filters( ‘comment_moderation_recipients’, string[] $emails, int $comment_id )

Filters the list of recipients for comment moderation emails.

apply_filters( ‘comment_moderation_subject’, string $subject, int $comment_id )

Filters the comment moderation email subject.

apply_filters( ‘comment_moderation_text’, string $notify_message, int $comment_id )

Filters the comment moderation email text.

apply_filters( ‘notify_moderator’, bool $maybe_notify, int $comment_id )

Filters whether to send the site moderator email notifications, overriding the site setting.

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.
user_can()wp-includes/capabilities.php

Returns whether a particular user has the specified capability.
_n()wp-includes/l10n.php

Translates and retrieves the singular or plural form based on the supplied number.
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.
__()wp-includes/l10n.php

Retrieves the translation of $text.
get_userdata()wp-includes/pluggable.php

Retrieves user info by user ID.
number_format_i18n()wp-includes/functions.php

Converts float number to format based on the locale.
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_post()wp-includes/post.php

Retrieves post data given a post ID or post object.
wpdb::get_var()wp-includes/class-wpdb.php

Retrieves one value from the database.
get_comment()wp-includes/comment.php

Retrieves comment data given a comment ID or comment object.

Show 15 moreShow less

Used by Description
wp_new_comment_notify_moderator()wp-includes/comment.php

Sends a comment moderation notification to the comment moderator.

Changelog

Version Description
1.0.0 Introduced.