钩子文档

retrieve_password

💡 云策文档标注

概述

retrieve_password 是一个 WordPress 动作钩子,在用户密码重置过程中,新密码被检索之前触发。它允许开发者在密码重置流程中执行自定义操作。

关键要点

  • 这是一个动作钩子,用于在密码重置前执行代码。
  • 参数 $user_login 是字符串类型,表示用户的登录名。
  • 从 WordPress 1.5.1 版本开始引入。

代码示例

do_action( 'retrieve_password', $user->user_login );

注意事项

  • 此钩子与 get_password_reset_key() 函数相关,后者用于创建和存储密码重置密钥。
  • 开发者可以添加自定义函数来响应此钩子,例如记录日志或发送通知。

📄 原文内容

Fires before a new password is retrieved.

Parameters

$user_loginstring
The user login name.

Source

do_action( 'retrieve_password', $user->user_login );

Changelog

Version Description
1.5.1 Introduced.