钩子文档

lostpassword_user_data

💡 云策文档标注

概述

lostpassword_user_data 是一个 WordPress 过滤器钩子,用于在密码重置请求期间过滤用户数据。它允许开发者基于用户名或邮箱地址之外的数据进行自定义验证。

关键要点

  • 这是一个过滤器钩子,用于修改或验证密码重置过程中的用户数据。
  • 参数包括 $user_data(WP_User 对象或 false)和 $errors(WP_Error 对象)。
  • 可用于实现自定义验证逻辑,例如基于其他用户属性。
  • 在 retrieve_password() 函数中使用,处理密码重置邮件的发送。
  • 自 WordPress 5.7.0 版本引入。

代码示例

$user_data = apply_filters( 'lostpassword_user_data', $user_data, $errors );

📄 原文内容

Filters the user data during a password reset request.

Description

Allows, for example, custom validation using data other than username or email address.

Parameters

$user_dataWP_User|false
WP_User object if found, false if the user does not exist.
$errorsWP_Error
A WP_Error object containing any errors generated by using invalid credentials.

Source

$user_data = apply_filters( 'lostpassword_user_data', $user_data, $errors );

Changelog

Version Description
5.7.0 Introduced.