发布于 由admin

阐述 WordPress `wp_notify_moderator()` 函数的源码：如何向管理员发送评论待审核的通知。

早上好，各位！今天咱们来聊聊 WordPress 的 wp_notify_moderator() 函数，这个函数啊，就像一个尽职尽责的信使，专门负责把“有新评论待审核啦！”的消息传递给网站管理员。咱们要扒一扒它的源码，看看它到底是怎么实现的，以及背后隐藏的一些小秘密。

1. 初识 wp_notify_moderator()：我们的信使

首先，wp_notify_moderator() 函数的主要作用就是当有新的评论提交到你的 WordPress 网站时，它会发送邮件通知网站管理员，告诉他们有评论需要审核。这样管理员就能及时发现并处理这些评论，保持网站内容的健康。

2. 源码探秘：信使的内部运作

咱们直接上源码，一起来看看这个信使是怎么工作的。wp-includes/comment.php 文件里就能找到它：

function wp_notify_moderator( $comment_id ) {
    $comment = get_comment( $comment_id );

    if ( ! $comment ) {
        return;
    }

    if ( 'approved' === $comment->comment_approved ) {
        return;
    }

    $admin_email = get_option( 'admin_email' );

    if ( ! is_email( $admin_email ) ) {
        return;
    }

    $switched_locale = switch_to_locale( get_locale() );

    $comment_author_domain = @gethostbyaddr( $comment->comment_author_IP );
    $comment_author_domain = preg_replace( '/^www./', '', $comment_author_domain );

    $subject = sprintf(
        /* translators: 1: Site title, 2: Comment author */
        __( '[%1$s] Please moderate: "%2$s"' ),
        wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES ),
        wp_specialchars_decode( $comment->comment_author, ENT_QUOTES )
    );

    $message  = sprintf( __( 'A new comment on the post "%1$s" is waiting for your approval' ), $comment->comment_post_title ) . "rn";
    $message .= get_permalink( $comment->comment_post_ID ) . "rnrn";
    $message .= sprintf( __( 'Author : %1$s (IP: %2$s, %3$s)' ), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "rn";
    $message .= sprintf( __( 'Email  : %s' ), $comment->comment_author_email ) . "rn";
    $message .= sprintf( __( 'URL    : %s' ), $comment->comment_author_url ) . "rn";
    $message .= sprintf( __( 'Whois  : http://who.is/whois/%s' ), $comment->comment_author_IP ) . "rn";
    $message .= __( 'Comment: ' ) . "rn" . $comment->comment_content . "rnrn";
    $message .= sprintf( __( 'Approve it: %s' ), admin_url( "comment.php?action=approve&c=$comment_id" ) ) . "rn";
    $message .= sprintf( __( 'Trash it: %s' ), admin_url( "comment.php?action=trash&c=$comment_id" ) ) . "rn";
    $message .= sprintf( __( 'Spam it: %s' ), admin_url( "comment.php?action=spam&c=$comment_id" ) ) . "rn";

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

    if ( wp_startswith( $admin_email, 'wordpress@' ) ) {
        $from = "WordPress <$wp_email>";
    } else {
        $from = "WordPress <$admin_email>";
    }

    $headers = array(
        "From: $from",
        "Content-Type: text/plain; charset="" . get_option( 'blog_charset' ) . """,
        "Reply-To: " . $comment->comment_author_email,
    );

    wp_mail( $admin_email, $subject, $message, $headers );

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

代码虽然有点长，但咱们可以把它分解成几个小步骤：

  1. 获取评论信息： 首先，通过 get_comment( $comment_id ) 函数获取评论的所有信息，包括作者、内容、IP 地址等等。如果获取不到评论，或者评论已经通过审核，函数就直接返回，什么也不做。

    $comment = get_comment( $comment_id );

if ( ! $comment ) {
    return;
}

if ( 'approved' === $comment->comment_approved ) {
    return;
}

  2. 获取管理员邮箱： 接下来，它会通过 get_option( 'admin_email' ) 获取网站管理员的邮箱地址。如果获取到的邮箱地址不是有效的邮箱格式，函数也会直接返回。

    $admin_email = get_option( 'admin_email' );

if ( ! is_email( $admin_email ) ) {
    return;
}

  3. 切换语言环境 (Locale)： switch_to_locale( get_locale() ) 这一行代码是为了确保邮件内容能根据网站的语言环境进行本地化。如果网站使用了不同的语言，那么通知邮件的内容也会使用相应的语言。 函数返回一个布尔值，指示是否切换了语言环境，以便稍后可以恢复。

    $switched_locale = switch_to_locale( get_locale() );

  4. 构建邮件主题： 使用 sprintf 函数和 __() 函数构建邮件的主题。__() 函数是 WordPress 的国际化函数，可以根据网站的语言环境翻译字符串。主题的格式通常是 "[网站名称] 请审核: "评论作者""。

    $subject = sprintf(
    /* translators: 1: Site title, 2: Comment author */
    __( '[%1$s] Please moderate: "%2$s"' ),
    wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES ),
    wp_specialchars_decode( $comment->comment_author, ENT_QUOTES )
);

  5. 构建邮件内容： 这部分是邮件的核心内容，包括评论的各种信息，以及审核、垃圾评论等操作的链接。它使用 sprintf 函数和 __() 函数将各种信息格式化成一段文本。

    $message  = sprintf( __( 'A new comment on the post "%1$s" is waiting for your approval' ), $comment->comment_post_title ) . "rn";
$message .= get_permalink( $comment->comment_post_ID ) . "rnrn";
$message .= sprintf( __( 'Author : %1$s (IP: %2$s, %3$s)' ), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "rn";
$message .= sprintf( __( 'Email  : %s' ), $comment->comment_author_email ) . "rn";
$message .= sprintf( __( 'URL    : %s' ), $comment->comment_author_url ) . "rn";
$message .= sprintf( __( 'Whois  : http://who.is/whois/%s' ), $comment->comment_author_IP ) . "rn";
$message .= __( 'Comment: ' ) . "rn" . $comment->comment_content . "rnrn";
$message .= sprintf( __( 'Approve it: %s' ), admin_url( "comment.php?action=approve&c=$comment_id" ) ) . "rn";
$message .= sprintf( __( 'Trash it: %s' ), admin_url( "comment.php?action=trash&c=$comment_id" ) ) . "rn";
$message .= sprintf( __( 'Spam it: %s' ), admin_url( "comment.php?action=spam&c=$comment_id" ) ) . "rn";

    这里注意几个点：

    • get_permalink( $comment->comment_post_ID ): 获取评论所属文章的链接。
    • admin_url( "comment.php?action=approve&c=$comment_id" ): 生成审核、垃圾评论等操作的后台链接。
    • $comment_author_domain = @gethostbyaddr( $comment->comment_author_IP ): 尝试通过IP地址反向解析域名。@符号抑制错误显示，因为反向解析可能失败。

  6. 设置邮件头： 设置邮件的 From、Content-Type 和 Reply-To 头部。From 头部表示邮件的发送者，Content-Type 头部表示邮件的内容类型，Reply-To 头部表示回复邮件的地址。

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

if ( wp_startswith( $admin_email, 'wordpress@' ) ) {
    $from = "WordPress <$wp_email>";
} else {
    $from = "WordPress <$admin_email>";
}

$headers = array(
    "From: $from",
    "Content-Type: text/plain; charset="" . get_option( 'blog_charset' ) . """,
    "Reply-To: " . $comment->comment_author_email,
);

    这里 wp_startswith() 函数检查管理员邮箱是否以 wordpress@ 开头。如果是，则使用 WordPress 默认的邮箱地址；否则，使用管理员邮箱地址。这样做的目的是为了防止邮件被标记为垃圾邮件。

  7. 发送邮件： 最后，使用 wp_mail() 函数发送邮件。wp_mail() 函数是 WordPress 内置的邮件发送函数，它会对邮件进行一些处理，例如添加 X-Mailer 头部，并使用 WordPress 的邮件发送机制发送邮件。

    wp_mail( $admin_email, $subject, $message, $headers );

  8. 恢复语言环境： 如果之前切换了语言环境，那么这里会使用 restore_previous_locale() 函数恢复之前的语言环境。

    if ( $switched_locale ) {
    restore_previous_locale();
}

3. wp_mail() 函数：邮件发送的核心

wp_notify_moderator() 函数的核心是 wp_mail() 函数，它负责实际发送邮件。wp_mail() 函数位于 wp-includes/pluggable.php 文件中。咱们简单看一下它的工作原理：

function wp_mail( $to, $subject, $message, $headers = '', $attachments = array() ) {
    // (省略大量代码)

    /**
     * Fires after the email is sent.
     *
     * @since 2.2.0
     *
     * @param array $args Array of {@see wp_mail()} arguments.
     */
    do_action( 'wp_mail_succeeded', $args );

    return $result;
}

wp_mail() 函数接收五个参数：

  • $to: 收件人邮箱地址。
  • $subject: 邮件主题。
  • $message: 邮件内容。
  • $headers: 邮件头部信息，是一个字符串或数组。
  • $attachments: 邮件附件，是一个数组。

wp_mail() 函数内部会使用 PHP 的 mail() 函数或者通过 SMTP 服务器发送邮件。具体使用哪种方式取决于 WordPress 的配置。它还提供了一些钩子（hooks），允许开发者自定义邮件的内容、头部信息和发送方式。

4. 钩子 (Hooks)：可扩展的信使

wp_notify_moderator() 函数并没有提供直接的钩子，但是 wp_mail() 函数提供了 wp_mail_succeeded 和 wp_mail_failed 钩子，允许你对邮件发送的结果进行处理。

例如，你可以使用 wp_mail_succeeded 钩子记录成功发送的邮件信息：

add_action( 'wp_mail_succeeded', 'my_log_successful_email' );

function my_log_successful_email( $args ) {
    // 将邮件信息记录到日志中
    error_log( 'Successfully sent email to: ' . $args['to'] . ' with subject: ' . $args['subject'] );
}

5. 使用场景：信使的应用

wp_notify_moderator() 函数通常在以下场景中使用：

  • 评论提交时： 当用户提交新的评论时，会自动调用 wp_notify_moderator() 函数，通知管理员审核评论。
  • 自定义评论处理： 如果你自定义了评论的处理流程，可以在适当的时候手动调用 wp_notify_moderator() 函数，发送通知邮件。

6. 安全性考虑：别让信使被利用

  • 防止垃圾邮件： 确保你的网站配置了合适的反垃圾邮件措施，例如使用 Akismet 插件，可以减少垃圾评论的产生，从而减少 wp_notify_moderator() 函数的调用次数。
  • 限制评论频率： 可以限制用户的评论频率，防止恶意用户通过大量提交评论来发送垃圾邮件。
  • 验证码： 使用验证码可以有效防止机器人提交评论。

7. 总结：信使的价值

wp_notify_moderator() 函数虽然看起来简单，但它在 WordPress 评论管理中起着至关重要的作用。它就像一个尽职尽责的信使，及时将新的评论信息传递给管理员，帮助管理员及时审核和处理评论，保持网站内容的健康。

咱们来用一个表格总结一下 wp_notify_moderator() 函数的关键要素：

要素 描述
功能 发送邮件通知网站管理员有新的评论需要审核。
调用时机 当有新的评论提交，且评论状态为待审核时。
主要步骤 获取评论信息 -> 获取管理员邮箱 -> 构建邮件主题和内容 -> 设置邮件头 -> 发送邮件。
依赖函数 get_comment(), get_option(), wp_mail(), switch_to_locale(), restore_previous_locale()
安全性考虑 防止垃圾邮件，限制评论频率，使用验证码。
可扩展性 通过 wp_mail() 函数提供的钩子，可以自定义邮件的内容、头部信息和发送方式。

好了，今天的 wp_notify_moderator() 函数源码分析就到这里。希望通过这次的讲解，大家对这个函数有了更深入的了解。下次再见！

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注