sanitize_email
云策文档标注
概述
sanitize_email 是一个 WordPress 过滤器，用于在清理电子邮件地址时应用自定义逻辑。它允许开发者在不同验证上下文中修改或检查已清理的电子邮件地址。
关键要点
- 过滤器名称：sanitize_email，用于过滤已清理的电子邮件地址。
- 上下文：过滤器可在多个验证上下文中触发，如 'email_too_short'、'email_no_at' 等，或无上下文。
- 参数：接受 $sanitized_email（已清理的电子邮件地址）、$email（原始电子邮件地址）和 $message（可选的用户消息）。
- 相关函数：与 sanitize_email() 函数配合使用，该函数移除电子邮件中不允许的字符。
- 版本历史：自 WordPress 2.8.0 版本引入。
原文内容
Filters a sanitized email address.
Description
This filter is evaluated under several contexts, including ’email_too_short’, ’email_no_at’, ‘local_invalid_chars’, ‘domain_period_sequence’, ‘domain_period_limits’, ‘domain_no_periods’, ‘domain_no_valid_subs’, or no context.
Parameters
$sanitized_emailstring-
The sanitized email address.
$emailstring-
The email address, as provided to sanitize_email() .
More Arguments from sanitize_email( … $email )
Email address to filter.
$messagestring|null-
A message to pass to the user. null if email is sanitized.
Source
return apply_filters( 'sanitize_email', '', $email, 'email_too_short' );
Changelog
| Version | Description |
|---|---|
| 2.8.0 | Introduced. |