lostpassword_errors
云策文档标注
概述
lostpassword_errors 是一个 WordPress 过滤器，用于在密码重置请求中处理遇到的错误。它允许开发者修改或添加错误信息，例如无效用户名或邮箱地址的错误，并可能中止密码重置过程。
关键要点
- 过滤器名称：lostpassword_errors，用于过滤密码重置请求中的错误。
- 参数：$errors（WP_Error 对象，包含错误信息）和 $user_data（WP_User 对象或 false，表示用户是否存在）。
- 功能：如果 $errors 包含错误，将中止密码重置请求；必须始终返回 WP_Error 对象，但可以包含或不包含错误。
- 相关函数：retrieve_password() 用于处理发送密码重置邮件。
- 版本历史：从 WordPress 5.5.0 版本引入。
原文内容
Filters the errors encountered on a password reset request.
Description
The filtered WP_Error object may, for example, contain errors for an invalid username or email address. A WP_Error object should always be returned, but may or may not contain errors.
If any errors are present in $errors, this will abort the password reset request.
Parameters
Source
$errors = apply_filters( 'lostpassword_errors', $errors, $user_data );
Changelog
| Version | Description |
|---|---|
| 5.5.0 | Introduced. |