钩子文档

update_welcome_user_email

💡 云策文档标注

概述

update_welcome_user_email 是一个 WordPress 过滤器钩子,用于在用户账户激活后过滤欢迎邮件的内容。它允许开发者自定义邮件正文,并确保内容格式适合通过 wp_mail() 函数发送。

关键要点

  • 这是一个过滤器钩子,用于修改用户激活成功后的欢迎邮件内容。
  • 参数包括 $welcome_email(邮件正文)、$user_id(用户ID)、$password(用户密码)和 $meta(注册元数据,默认为空数组)。
  • 在 WordPress MU 3.0.0 版本中引入,主要用于多站点环境。

代码示例

$welcome_email = apply_filters( 'update_welcome_user_email', $welcome_email, $user_id, $password, $meta );

注意事项

邮件内容应格式化为适合 wp_mail() 传输,以确保正确发送。


📄 原文内容

Filters the content of the welcome email after user activation.

Description

Content should be formatted for transmission via wp_mail() .

Parameters

$welcome_emailstring
The message body of the account activation success email.
$user_idint
User ID.
$passwordstring
User password.
$metaarray
Signup meta data. Default empty array.

Source

$welcome_email = apply_filters( 'update_welcome_user_email', $welcome_email, $user_id, $password, $meta );

Changelog

Version Description
MU (3.0.0) Introduced.