钩子文档

xmlrpc_login_error

💡 云策文档标注

概述

xmlrpc_login_error 是一个 WordPress 过滤器钩子,用于修改 XML-RPC 用户登录时的错误消息。它允许开发者自定义错误响应,以增强安全性或提供更友好的提示。

关键要点

  • 过滤器名称:xmlrpc_login_error
  • 参数:$error(IXR_Error 对象,表示 XML-RPC 错误消息)和 $user(WP_Error 对象,表示用户错误信息)
  • 应用场景:在 XML-RPC 登录过程中,通过 apply_filters 调用,位于 wp_xmlrpc_server::login() 方法中
  • 版本历史:自 WordPress 3.5.0 版本引入

📄 原文内容

Filters the XML-RPC user login error message.

Parameters

$errorIXR_Error
The XML-RPC error message.
$userWP_Error
WP_Error object.

Source

$this->error = apply_filters( 'xmlrpc_login_error', $this->error, $user );

Changelog

Version Description
3.5.0 Introduced.