wp_ajax_ajax_tag_search()

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_ajax_tag_search() 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_terms().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

76–103

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

Plugin surface

2 hooks

Third-party callbacks on 'term_search_min_chars', 'ajax_term_search_results' 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_terms()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 · 32 distinct outcomes

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

Hooks and filters fired · 2

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

1. 1
   apply_filters( term_search_min_chars )filterline 145 (+39 into the body)

   Filters the minimum number of characters required to fire a tag search via Ajax.

2. 2
   apply_filters( ajax_term_search_results )filterline 174 (+68 into the body)

   Filters the Ajax term search results.

Uses · 10

• wp_die()Kills WordPress execution and displays HTML page with an error message.
• sanitize_key()Sanitizes a string key.
• get_taxonomy()Retrieves the taxonomy object of $taxonomy.
• current_user_can()Returns whether the current user has the specified capability.
• wp_unslash()Removes slashes from a string or recursively removes slashes from strings within an array.
• _x()Retrieves translated string with gettext context.
• str_contains()Polyfill for `str_contains()` function added in PHP 8.0.
• array_last()Polyfill for `array_last()` function added in PHP 8.5.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• get_terms()Retrieves the terms in a given taxonomy or list of taxonomies.

Source code

View on Trac ↗View on GitHub ↗

106function wp_ajax_ajax_tag_search() {107	if ( ! isset( $_GET['tax'] ) ) {108		wp_die( 0 );109	}110 111	$taxonomy        = sanitize_key( $_GET['tax'] );112	$taxonomy_object = get_taxonomy( $taxonomy );113 114	if ( ! $taxonomy_object ) {115		wp_die( 0 );116	}117 118	if ( ! current_user_can( $taxonomy_object->cap->assign_terms ) ) {119		wp_die( -1 );120	}121 122	$search = wp_unslash( $_GET['q'] );123 124	$comma = _x( ',', 'tag delimiter' );125	if ( ',' !== $comma ) {126		$search = str_replace( $comma, ',', $search );127	}128 129	if ( str_contains( $search, ',' ) ) {130		$search = explode( ',', $search );131		$search = array_last( $search );132	}133 134	$search = trim( $search );135 136	/**137	 * Filters the minimum number of characters required to fire a tag search via Ajax.138	 *139	 * @since 4.0.0140	 *141	 * @param int         $characters      The minimum number of characters required. Default 2.142	 * @param WP_Taxonomy $taxonomy_object The taxonomy object.143	 * @param string      $search          The search term.144	 */145	$term_search_min_chars = (int) apply_filters( 'term_search_min_chars', 2, $taxonomy_object, $search );146 147	/*148	 * Require $term_search_min_chars chars for matching (default: 2)149	 * ensure it's a non-negative, non-zero integer.150	 */151	if ( ( 0 === $term_search_min_chars ) || ( strlen( $search ) < $term_search_min_chars ) ) {152		wp_die();153	}154 155	$results = get_terms(156		array(157			'taxonomy'   => $taxonomy,158			'name__like' => $search,159			'fields'     => 'names',160			'hide_empty' => false,161			'number'     => isset( $_GET['number'] ) ? (int) $_GET['number'] : 0,162		)163	);164 165	/**166	 * Filters the Ajax term search results.167	 *168	 * @since 6.1.0169	 *170	 * @param string[]    $results         Array of term names.171	 * @param WP_Taxonomy $taxonomy_object The taxonomy object.172	 * @param string      $search          The search term.173	 */174	$results = apply_filters( 'ajax_term_search_results', $results, $taxonomy_object, $search );175 176	echo implode( "\n", $results );177	wp_die();178}

Changelog

Introduced in 3.1.0. 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-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.