钩子文档

wp_login_failed

💡 云策文档标注

概述

wp_login_failed 是一个 WordPress 钩子,在用户登录失败后触发,用于处理认证失败事件。

关键要点

  • 触发时机:用户登录失败后立即执行
  • 参数:$username(用户名或邮箱地址)和 $error(WP_Error 对象,包含认证失败详情)
  • 源调用:do_action( 'wp_login_failed', $username, $error )
  • 版本变更:5.4.0 添加 $error 参数,4.5.0 支持邮箱地址作为 $username,2.5.0 引入

相关函数

  • wp_authenticate():在 wp-includes/pluggable.php 中,用于验证用户登录凭据

📄 原文内容

Fires after a user login has failed.

Parameters

$usernamestring
Username or email address.
$errorWP_Error
A WP_Error object with the authentication failure details.

Source

do_action( 'wp_login_failed', $username, $error );

Changelog

Version Description
5.4.0 The $error parameter was added.
4.5.0 The value of $username can now be an email address.
2.5.0 Introduced.