xmlrpc_login_error

Filter Hook

Description

Filters the XML-RPC user login error message.

Hook Information

File Location	`wp-includes/class-wp-xmlrpc-server.php` View on GitHub
Hook Type	Filter
Line Number	`318`

Hook Parameters

Type	Name	Description
`IXR_Error`	`$error`	The XML-RPC error message.
`WP_Error`	`$user`	WP_Error object.

Usage Examples

Basic Usage

<?php
// Hook into xmlrpc_login_error
add_filter('xmlrpc_login_error', 'my_custom_filter', 10, 2);

function my_custom_filter($error, $user) {
    // Your custom filtering logic here
    return $error;
}

Source Code Context

wp-includes/class-wp-xmlrpc-server.php:318 - How this hook is used in WordPress core

<?php
 313  			 * @since 3.5.0
 314  			 *
 315  			 * @param IXR_Error $error The XML-RPC error message.
 316  			 * @param WP_Error  $user  WP_Error object.
 317  			 */
 318  			$this->error = apply_filters( 'xmlrpc_login_error', $this->error, $user );
 319  			return false;
 320  		}
 321  
 322  		wp_set_current_user( $user->ID );
 323  		return $user;

PHP Documentation

<?php
/**
			 * Filters the XML-RPC user login error message.
			 *
			 * @since 3.5.0
			 *
			 * @param IXR_Error $error The XML-RPC error message.
			 * @param WP_Error  $user  WP_Error object.
			 */

Quick Info

Hook Type: Filter
Parameters: 2
File: wp-includes/class-wp-xmlrpc-server.php

Links

WordPress Docs View Source Code Search Examples

Related Hooks

Related hooks will be displayed here in future updates.