钩子文档

retrieve_password_key

💡 云策文档标注

概述

retrieve_password_key 是一个 WordPress 动作钩子,在生成密码重置密钥时触发,允许开发者在重置过程中执行自定义操作。

关键要点

  • 触发时机:当密码重置密钥生成时触发,例如在用户请求重置密码时。
  • 参数:接收两个参数:$user_login(用户名)和$key(生成的密码重置密钥)。
  • 用途:常用于日志记录、通知发送或自定义验证逻辑。
  • 相关函数:与 get_password_reset_key() 函数关联,该函数在 wp-includes/user.php 中创建和存储密钥。
  • 版本历史:自 WordPress 2.5.0 版本引入。

代码示例

do_action( 'retrieve_password_key', $user->user_login, $key );

📄 原文内容

Fires when a password reset key is generated.

Parameters

$user_loginstring
The username for the user.
$keystring
The generated password reset key.

Source

do_action( 'retrieve_password_key', $user->user_login, $key );

Changelog

Version Description
2.5.0 Introduced.