wp_ajax_autocomplete_user()

Compatibility

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

Performance profile

How much work a call to wp_ajax_autocomplete_user() 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 how much data it finds.

Instructions

55–101

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

Plugin surface

1 hook

Third-party callbacks on 'autocomplete_users_for_site_admins' 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 · 72 distinct outcomes

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

Hooks and filters fired · 1

One hook fires while wp_ajax_autocomplete_user() runs, in this order:

1. 1
   apply_filters( autocomplete_users_for_site_admins )filterline 295 (+6 into the body)

   Filters whether to enable user auto-complete for non-super admins in Multisite.

Uses · 10

• is_multisite()Determines whether Multisite is enabled.
• current_user_can()Returns whether the current user has the specified capability.
• wp_is_large_network()Determines whether or not we have a large network.
• wp_die()Kills WordPress execution and displays HTML page with an error message.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• absint()Converts a value to non-negative integer.
• get_current_blog_id()Retrieves the current site ID.
• get_users()Retrieves list of users matching criteria.
• _x()Retrieves translated string with gettext context.
• wp_json_encode()Encodes a variable into JSON, with some confidence checks.

Source code

View on Trac ↗View on GitHub ↗

289function wp_ajax_autocomplete_user() {290	if ( ! is_multisite() || ! current_user_can( 'promote_users' ) || wp_is_large_network( 'users' ) ) {291		wp_die( -1 );292	}293 294	/** This filter is documented in wp-admin/user-new.php */295	if ( ! current_user_can( 'manage_network_users' ) && ! apply_filters( 'autocomplete_users_for_site_admins', false ) ) {296		wp_die( -1 );297	}298 299	$return = array();300 301	/*302	 * Check the type of request.303	 * Current allowed values are `add` and `search`.304	 */305	if ( isset( $_REQUEST['autocomplete_type'] ) && 'search' === $_REQUEST['autocomplete_type'] ) {306		$type = $_REQUEST['autocomplete_type'];307	} else {308		$type = 'add';309	}310 311	/*312	 * Check the desired field for value.313	 * Current allowed values are `user_email` and `user_login`.314	 */315	if ( isset( $_REQUEST['autocomplete_field'] ) && 'user_email' === $_REQUEST['autocomplete_field'] ) {316		$field = $_REQUEST['autocomplete_field'];317	} else {318		$field = 'user_login';319	}320 321	// Exclude current users of this blog.322	if ( isset( $_REQUEST['site_id'] ) ) {323		$id = absint( $_REQUEST['site_id'] );324	} else {325		$id = get_current_blog_id();326	}327 328	$include_blog_users = ( 'search' === $type ? get_users(329		array(330			'blog_id' => $id,331			'fields'  => 'ID',332		)333	) : array() );334 335	$exclude_blog_users = ( 'add' === $type ? get_users(336		array(337			'blog_id' => $id,338			'fields'  => 'ID',339		)340	) : array() );341 342	$users = get_users(343		array(344			'blog_id'        => false,345			'search'         => '*' . $_REQUEST['term'] . '*',346			'include'        => $include_blog_users,347			'exclude'        => $exclude_blog_users,348			'search_columns' => array( 'user_login', 'user_nicename', 'user_email' ),349		)350	);351 352	foreach ( $users as $user ) {353		$return[] = array(354			/* translators: 1: User login, 2: User email address. */355			'label' => sprintf( _x( '%1$s (%2$s)', 'user autocomplete result' ), $user->user_login, $user->user_email ),356			'value' => $user->$field,357		);358	}359 360	wp_die( wp_json_encode( $return ) );361}

Changelog

Introduced in 3.4.0. One change between 6.7.7 and 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.0.4 tag, from src/wp-admin/includes/ajax-actions.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.