xmlrpc_login_error

Filters the XML-RPC user login error message.

Description

apply_filters( 'xmlrpc_login_error', (string) $this_error, (WP_User) $user ); 

Parameters (2)

0. $this_error (string)
The XML-RPC error message.
1. $user (WP_User)
WP_User object.

Usage

To run the hook, copy the example below.
  1. $this_error = apply_filters( 'xmlrpc_login_error', $this_error, $user ); 
  2.  
  3. if ( !empty( $this_error ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the xmlrpc_login_error callback 
  2. function filter_xmlrpc_login_error( $this_error, $user ) { 
  3. // make filter magic happen here... 
  4. return $this_error
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'xmlrpc_login_error', 'filter_xmlrpc_login_error', 10, 2 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'xmlrpc_login_error', 'filter_xmlrpc_login_error', 10, 2 ); 

Defined (1)

The filter is defined in the following location(s).

/wp-includes/class-wp-xmlrpc-server.php  
  1. $this->error = apply_filters( 'xmlrpc_login_error', $this->error, $user );