钩子文档

lost_password

💡 云策文档标注

概述

lost_password Hook 在密码重置表单显示前触发,允许开发者处理错误或执行自定义操作。它传递一个 WP_Error 对象作为参数,用于检查登录凭证相关的错误。

关键要点

  • Hook 名称:lost_password
  • 触发时机:在密码重置表单显示之前
  • 参数:$errors(WP_Error 对象),可能包含无效凭证生成的错误,也可能为空
  • 版本历史:从 WordPress 1.5.1 引入,5.1.0 版本添加了 $errors 参数

代码示例

do_action( 'lost_password', $errors );

📄 原文内容

Fires before the lost password form.

Parameters

$errorsWP_Error
A WP_Error object containing any errors generated by using invalid credentials. Note that the error object may not contain any errors.

Source

do_action( 'lost_password', $errors );

Changelog

Version Description
5.1.0 Added the $errors parameter.
1.5.1 Introduced.