wp_xmlrpc_server::wp_getUsers( array $args ): array|IXR_Error

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$argsarray

Method arguments. Note: arguments must be ordered as documented.

• $0int

  Blog ID (unused).

• $1string

  Username.

• $2string

  Password.

• $3array

  Optional. Arguments for the user query.

• $4array

  Optional. Fields to return.

Return value

array|IXR_Error

users data

Performance profile

How much work a call to wp_xmlrpc_server::wp_getUsers() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reaches the database via get_users().

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

8–99

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 137.

Plugin surface

2 hooks

Third-party callbacks on 'xmlrpc_default_user_fields', 'xmlrpc_call' run inside this call, and their cost is not bounded by anything here.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksapply_filters()called directly
• querycontent queryget_users()called directly

Further down the call graph this can also reach option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 23 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_xmlrpc_server::wp_getUsers() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 2

2 hooks fire while wp_xmlrpc_server::wp_getUsers() runs, in this order:

1. 1
   apply_filters( xmlrpc_default_user_fields )filterline 2783 (+15 into the body)

   Filters the default user query fields used by the given XML-RPC method.

2. 2
   do_action( xmlrpc_call )actionline 2792 (+24 into the body)

   Fires after the XML-RPC user has been authenticated but before the rest of the method logic begins.

Uses · 12

• apply_filters()Calls the callback functions that have been added to a filter hook.
• do_action()Calls the callback functions that have been added to an action hook.
• current_user_can()Returns whether the current user has the specified capability.
• __()Retrieves the translation of $text.
• absint()Converts a value to non-negative integer.
• get_role()Retrieves role object.
• get_users()Retrieves list of users matching criteria.
• wp_xmlrpc_server::minimum_args()Checks if the method received at least the minimum number of arguments.
• wp_xmlrpc_server::escape()Escapes string or array of strings for database.
• wp_xmlrpc_server::login()Logs user in.
• IXR_Error::__construct()PHP5 constructor.
• wp_xmlrpc_server::_prepare_user()Prepares user data for return in an XML-RPC object.

Source code

View on Trac ↗View on GitHub ↗

2768	public function wp_getUsers( $args ) {2769		if ( ! $this->minimum_args( $args, 3 ) ) {2770			return $this->error;2771		}2772 2773		$this->escape( $args );2774 2775		$username = $args[1];2776		$password = $args[2];2777		$filter   = $args[3] ?? array();2778 2779		if ( isset( $args[4] ) ) {2780			$fields = $args[4];2781		} else {2782			/** This action is documented in wp-includes/class-wp-xmlrpc-server.php */2783			$fields = apply_filters( 'xmlrpc_default_user_fields', array( 'all' ), 'wp.getUsers' );2784		}2785 2786		$user = $this->login( $username, $password );2787		if ( ! $user ) {2788			return $this->error;2789		}2790 2791		/** This action is documented in wp-includes/class-wp-xmlrpc-server.php */2792		do_action( 'xmlrpc_call', 'wp.getUsers', $args, $this );2793 2794		if ( ! current_user_can( 'list_users' ) ) {2795			return new IXR_Error( 401, __( 'Sorry, you are not allowed to list users.' ) );2796		}2797 2798		$query = array( 'fields' => 'all_with_meta' );2799 2800		$query['number'] = ( isset( $filter['number'] ) ) ? absint( $filter['number'] ) : 50;2801		$query['offset'] = ( isset( $filter['offset'] ) ) ? absint( $filter['offset'] ) : 0;2802 2803		if ( isset( $filter['orderby'] ) ) {2804			$query['orderby'] = $filter['orderby'];2805 2806			if ( isset( $filter['order'] ) ) {2807				$query['order'] = $filter['order'];2808			}2809		}2810 2811		if ( isset( $filter['role'] ) ) {2812			if ( get_role( $filter['role'] ) === null ) {2813				return new IXR_Error( 403, __( 'Invalid role.' ) );2814			}2815 2816			$query['role'] = $filter['role'];2817		}2818 2819		if ( isset( $filter['who'] ) ) {2820			$query['who'] = $filter['who'];2821		}2822 2823		$users = get_users( $query );2824 2825		$_users = array();2826		foreach ( $users as $user_data ) {2827			if ( current_user_can( 'edit_user', $user_data->ID ) ) {2828				$_users[] = $this->_prepare_user( $user_data, $fields );2829			}2830		}2831		return $_users;2832	}

Changelog

Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/class-wp-xmlrpc-server.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.