wp_ajax_autocomplete_user(): never

Compatibility

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

Return value

never

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

71–116

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

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 · 108 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.

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

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 299 (+6 into the body)

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

Uses · 12

• 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.
• sanitize_text_field()Sanitizes a string from user input or from the database.
• wp_unslash()Removes slashes from a string or recursively removes slashes from strings within an array.
• 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 ↗

293function wp_ajax_autocomplete_user() {294	if ( ! is_multisite() || ! current_user_can( 'promote_users' ) || wp_is_large_network( 'users' ) ) {295		wp_die( -1 );296	}297 298	/** This filter is documented in wp-admin/user-new.php */299	if ( ! current_user_can( 'manage_network_users' ) && ! apply_filters( 'autocomplete_users_for_site_admins', false ) ) {300		wp_die( -1 );301	}302 303	$return = array();304 305	// Obtain the search term, and short-circuit missing/invalid search term.306	if ( ! isset( $_REQUEST['term'] ) || ! is_string( $_REQUEST['term'] ) ) {307		wp_die( 0 );308	}309	/*310	 * Asterisks are trimmed since wildcards are appended below. Without this, a311	 * term consisting only of asterisks would result in an empty search that312	 * matches all users.313	 */314	$term = trim( sanitize_text_field( wp_unslash( $_REQUEST['term'] ) ), '*' );315	if ( '' === $term ) {316		wp_die( 0 );317	}318 319	/*320	 * Check the type of request.321	 * Current allowed values are `add` and `search`.322	 */323	if ( isset( $_REQUEST['autocomplete_type'] ) && 'search' === $_REQUEST['autocomplete_type'] ) {324		$type = $_REQUEST['autocomplete_type'];325	} else {326		$type = 'add';327	}328 329	/*330	 * Check the desired field for value.331	 * Current allowed values are `user_email` and `user_login`.332	 */333	if ( isset( $_REQUEST['autocomplete_field'] ) && 'user_email' === $_REQUEST['autocomplete_field'] ) {334		$field = $_REQUEST['autocomplete_field'];335	} else {336		$field = 'user_login';337	}338 339	// Exclude current users of this blog.340	if ( isset( $_REQUEST['site_id'] ) ) {341		$id = absint( $_REQUEST['site_id'] );342	} else {343		$id = get_current_blog_id();344	}345 346	$include_blog_users = ( 'search' === $type ? get_users(347		array(348			'blog_id' => $id,349			'fields'  => 'ID',350		)351	) : array() );352 353	$exclude_blog_users = ( 'add' === $type ? get_users(354		array(355			'blog_id' => $id,356			'fields'  => 'ID',357		)358	) : array() );359 360	$users = get_users(361		array(362			'blog_id'        => false,363			'search'         => '*' . $term . '*',364			'include'        => $include_blog_users,365			'exclude'        => $exclude_blog_users,366			'search_columns' => array( 'user_login', 'user_nicename', 'user_email' ),367		)368	);369 370	foreach ( $users as $user ) {371		$return[] = array(372			/* translators: 1: User login, 2: User email address. */

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.1.0 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.