wp_xmlrpc_server::wp_getProfile() WordPress Method
The wp_xmlrpc_server::wp_getProfile() method is used to retrieve a user's profile data. This data includes the user's display name, email address, website URL, and biography. This method can be used to get information about a user who is not logged in, as long as the user's ID is known.
wp_xmlrpc_server::wp_getProfile( array $args ) #
Retrieve information about the requesting user.
Parameters
- $args
(array)(Required)Method arguments. Note: arguments must be ordered as documented.
- 'blog_id'
(int) (unused) - 'username'
(string) - 'password'
(string) - 'fields'
(array) (optional)
- 'blog_id'
Return
(array|IXR_Error) (@see wp_getUser)
Source
File: wp-includes/class-wp-xmlrpc-server.php
public function wp_getProfile( $args ) {
if ( ! $this->minimum_args( $args, 3 ) ) {
return $this->error;
}
$this->escape( $args );
$username = $args[1];
$password = $args[2];
if ( isset( $args[3] ) ) {
$fields = $args[3];
} else {
/** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
$fields = apply_filters( 'xmlrpc_default_user_fields', array( 'all' ), 'wp.getProfile' );
}
$user = $this->login( $username, $password );
if ( ! $user ) {
return $this->error;
}
/** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
do_action( 'xmlrpc_call', 'wp.getProfile', $args, $this );
if ( ! current_user_can( 'edit_user', $user->ID ) ) {
return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit your profile.' ) );
}
$user_data = get_userdata( $user->ID );
return $this->_prepare_user( $user_data, $fields );
}
Expand full source codeCollapse full source codeView on TracView on GitHub