分析 WordPress `wp_mail()` 函数的源码：它如何封装 PHP 的 `mail()` 函数并提供过滤器。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

早上好，各位代码界的弄潮儿！今天咱们就来扒一扒 WordPress 里那个经常被咱们折腾，却又不得不用的 wp_mail() 函数的底裤，看看它到底是怎么把 PHP 原生的 mail() 函数给包装得如此风骚，又是怎么通过各种过滤器，让咱们可以随心所欲地操纵邮件发送过程。

开场白：wp_mail() 的江湖地位

在 WordPress 的世界里，想发邮件，那就得找 wp_mail()。它就像一个万能的快递员，负责把你的信息安全可靠地送到收件人的邮箱里。但是，这个快递员可不是直接拎起包裹就跑，它会先对包裹进行一番包装，贴上各种标签，甚至允许你修改包裹的内容和路线。

第一幕：wp_mail() 的庐山真面目

wp_mail() 函数的代码不算复杂，但麻雀虽小，五脏俱全。它主要做了以下几件事：

参数处理： 接收邮件的各种信息，比如收件人、主题、内容、附件等等。
数据清洗： 对收件人地址进行验证，确保邮件能顺利送达。
内容格式化： 如果没有指定邮件类型，会自动判断并设置合适的 Content-Type。
头部构建： 根据参数构建邮件头部，包括发件人、抄送、密送等等。
过滤器应用： 这是重点！通过各种过滤器，允许开发者修改邮件的各个方面。
调用 mail() 函数： 最终，还是得靠 PHP 的 mail() 函数把邮件发出去。
错误处理： 检查邮件是否发送成功，并返回结果。

咱们先来看一下 wp_mail() 函数的基本结构（以下代码为了方便理解，做了简化，并非 WordPress 源码完全一致）：

function wp_mail( $to, $subject, $message, $headers = '', $attachments = array() ) {
    // 1. 参数处理
    $to = is_array( $to ) ? $to : explode( ',', $to );
    $subject = trim( $subject );

    // 2. 获取 WordPress 配置的邮件参数
    $from = apply_filters( 'wp_mail_from', get_option( 'admin_email' ) );
    $from_name = apply_filters( 'wp_mail_from_name', 'WordPress' );

    // 3. 构建邮件头部
    $headers_arr = array();
    if ( ! empty( $headers ) ) {
        if ( is_array( $headers ) ) {
            $headers_arr = $headers;
        } else {
            $headers_arr = explode( "n", str_replace( "rn", "n", $headers ) );
        }
    }

    // 4. 内容类型判断
    $content_type = 'text/plain'; // 默认
    foreach ( $headers_arr as $header ) {
        if ( stripos( $header, 'content-type:' ) !== false ) {
            $content_type = trim( substr( $header, strpos( $header, ':' ) + 1 ) );
            break;
        }
    }

    $content_type = apply_filters( 'wp_mail_content_type', $content_type );

    // 5. 邮件字符编码设置
    $charset = apply_filters( 'wp_mail_charset', get_bloginfo( 'charset' ) );

    // 6. 构建完整的头部信息
    $phpmailer = new PHPMailer(true); // 使用 PHPMailer 类
    $phpmailer->CharSet = $charset;
    $phpmailer->From = $from;
    $phpmailer->FromName = $from_name;
    $phpmailer->Subject = $subject;
    $phpmailer->Body = $message;

    foreach ( $to as $recipient ) {
        $phpmailer->addAddress( $recipient );
    }

    foreach ($headers_arr as $header){
        if(stripos($header, 'cc:') !== false){
            $phpmailer->addCC(substr($header,strpos($header,':')+1));
        }
        if(stripos($header, 'bcc:') !== false){
            $phpmailer->addBCC(substr($header,strpos($header,':')+1));
        }
    }

    if ( ! empty( $attachments ) ) {
        foreach ( $attachments as $attachment ) {
            try {
                $phpmailer->addAttachment( $attachment );
            } catch ( phpmailerException $e ) {
                // 附件处理失败
            }
        }
    }

    // 7. 应用 wp_mail 过滤器
    $phpmailer = apply_filters( 'wp_mail', $phpmailer, array( 'to' => $to, 'subject' => $subject, 'message' => $message, 'headers' => $headers, 'attachments' => $attachments ) );

    // 8. 发送邮件
    try {
        $result = $phpmailer->send();
    } catch (phpmailerException $e) {
        // 发送失败
        $result = false;
    }

    // 9. 返回结果
    return apply_filters( 'wp_mail_succeeded', $result, array( 'to' => $to, 'subject' => $subject, 'message' => $message, 'headers' => $headers, 'attachments' => $attachments ) );
}

第二幕：过滤器的魅力

wp_mail() 函数最强大的地方就在于它提供了一系列的过滤器，让开发者可以在邮件发送的各个环节进行干预。这些过滤器就像一个个的拦截器，允许你修改邮件的收件人、发件人、主题、内容、头部信息，甚至可以修改 PHPMailer 对象本身。

咱们来具体看看几个常用的过滤器：

过滤器名称	作用	传递的参数
`wp_mail_from`	修改发件人邮箱地址	`$from` (原始发件人邮箱地址)
`wp_mail_from_name`	修改发件人姓名	`$from_name` (原始发件人姓名)
`wp_mail_content_type`	修改邮件内容类型 (Content-Type)	`$content_type` (原始内容类型)
`wp_mail_charset`	修改邮件字符编码	`$charset` (原始字符编码)
`wp_mail`	修改 PHPMailer 对象	`$phpmailer` (PHPMailer 对象), `$args` (包含 `to`, `subject`, `message`, `headers`, `attachments` 的数组)
`wp_mail_succeeded`	修改邮件发送结果 (true/false)	`$result` (发送结果), `$args` (包含 `to`, `subject`, `message`, `headers`, `attachments` 的数组)

举个栗子，假设你想把所有从 WordPress 发出的邮件的发件人改成 [email protected]，并且发件人姓名改成 "Example Website"，你可以这样写：

add_filter( 'wp_mail_from', 'my_custom_mail_from' );
function my_custom_mail_from( $original_email ) {
    return '[email protected]';
}

add_filter( 'wp_mail_from_name', 'my_custom_mail_from_name' );
function my_custom_mail_from_name( $original_name ) {
    return 'Example Website';
}

再来一个栗子，如果你想把所有邮件的内容类型改成 HTML，你可以这样写：

add_filter( 'wp_mail_content_type', 'my_custom_mail_content_type' );
function my_custom_mail_content_type( $content_type ) {
    return 'text/html';
}

最强大的过滤器是 wp_mail，它允许你直接操作 PHPMailer 对象，你可以修改任何 PHPMailer 提供的属性和方法，比如添加抄送、密送、设置优先级等等。

例如，添加一个抄送地址：

add_filter( 'wp_mail', 'my_custom_wp_mail' );
function my_custom_wp_mail( $phpmailer ) {
    $phpmailer->addCC( '[email protected]' );
    return $phpmailer;
}

第三幕：wp_mail() 与 mail() 函数的关系

wp_mail() 函数最终还是会调用 PHP 的 mail() 函数来发送邮件。但是，wp_mail() 并不是直接调用 mail()，而是通过 PHPMailer 这个强大的邮件发送类库来间接调用。

PHPMailer 做了很多事情，比如：

解决了 mail() 函数的字符编码问题： mail() 函数在处理非 ASCII 字符时可能会出现乱码，PHPMailer 可以很好地解决这个问题。
提供了更丰富的邮件功能： PHPMailer 支持 HTML 邮件、附件、抄送、密送等等，这些功能 mail() 函数都需要自己手动实现。
支持 SMTP 发送： PHPMailer 可以通过 SMTP 服务器发送邮件，这比直接使用 mail() 函数更可靠。

wp_mail() 函数默认情况下会尝试使用 WordPress 配置的 SMTP 设置来发送邮件。如果没有配置 SMTP，或者配置不正确，才会使用 PHP 的 mail() 函数。

第四幕：wp_mail() 的使用场景

wp_mail() 函数在 WordPress 中被广泛使用，比如：

发送用户注册邮件： 当用户注册新账号时，WordPress 会发送一封包含用户名和密码的邮件。
发送密码重置邮件： 当用户忘记密码时，WordPress 会发送一封包含重置链接的邮件。
发送评论通知邮件： 当有新的评论发表时，WordPress 会发送邮件通知作者。
发送更新通知邮件： 当 WordPress 有新的版本或者插件需要更新时，WordPress 会发送邮件通知管理员。
插件和主题可以使用 wp_mail() 发送自定义邮件： 比如发送订单确认邮件、联系表单提交邮件等等。

第五幕：wp_mail() 的调试技巧

wp_mail() 函数虽然方便，但有时候也会出现问题，比如邮件发送失败、邮件进入垃圾箱等等。这时候就需要进行调试。

以下是一些常用的调试技巧：

检查 WordPress 的 SMTP 设置： 确保 SMTP 服务器地址、端口、用户名、密码等信息都正确。
检查邮件是否进入垃圾箱： 很多邮件服务商会对邮件进行垃圾邮件过滤，如果邮件进入垃圾箱，可以尝试修改邮件内容、发件人地址等等。
使用插件进行调试： 有很多 WordPress 插件可以帮助你调试 wp_mail() 函数，比如 WP Mail SMTP、Easy WP SMTP 等等。这些插件可以记录邮件发送日志，方便你查找问题。

使用 wp_mail_failed 动作： wp_mail_failed 动作会在邮件发送失败时触发，你可以通过这个动作来记录错误信息或者发送错误通知。

add_action( 'wp_mail_failed', 'my_wp_mail_failed' );
function my_wp_mail_failed( $wp_error ) {
   error_log( 'wp_mail failed: ' . $wp_error->get_error_message() );
}

直接输出 PHPMailer 对象的信息： 在 wp_mail 过滤器中，可以打印 PHPMailer 对象的信息，查看邮件头、邮件内容等是否符合预期。注意：不要在生产环境这样做，会暴露敏感信息。
```
add_filter( 'wp_mail', 'debug_wp_mail' );
function debug_wp_mail( $phpmailer ) {
   echo '<pre>';
   print_r( $phpmailer );
   echo '</pre>';
   return $phpmailer;
}
```

第六幕：wp_mail() 的替代方案

虽然 wp_mail() 函数很方便，但在某些情况下，你可能需要考虑使用替代方案，比如：

使用专业的邮件发送服务： 比如 SendGrid、Mailgun、Amazon SES 等等。这些服务可以提供更高的邮件送达率和更好的性能。你可以使用插件将 WordPress 连接到这些服务。
使用第三方邮件发送类库： 除了 PHPMailer，还有很多其他的邮件发送类库，比如 SwiftMailer、Zend Mail 等等。但是，直接替换 wp_mail() 可能会比较复杂，需要修改 WordPress 核心代码（不建议）。

总结：wp_mail() 的精髓

wp_mail() 函数的精髓在于它对 PHP 的 mail() 函数进行了封装，并提供了丰富的过滤器，让开发者可以灵活地控制邮件发送过程。它就像一个瑞士军刀，虽然不是最专业的工具，但却可以解决大部分的邮件发送问题。

希望今天的讲解能让你对 wp_mail() 函数有更深入的了解。记住，代码的世界是充满乐趣的，大胆去尝试，去探索，你一定会发现更多的惊喜！下课！

发表回复 取消回复

发表回复取消回复