WP_REST_Term_Search_Handler::search_items( WP_REST_Request $request ): array

Compatibility

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

Parameters

$requestWP_REST_Request

Full REST request.

Return value

array

Associative array containing found IDs and total count for the matching search results.

• $idsint[]

  Found term IDs.

• $totalstring|int|WP_Error

  Numeric string containing the number of terms in that taxonomy, 0 if there are no results, or WP_Error if the requested taxonomy does not exist.

Performance profile

How much work a call to WP_REST_Term_Search_Handler::search_items() 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 ->query().

Scaling

Constant

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

Instructions

54–66

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

Plugin surface

1 hook

Third-party callbacks on 'rest_term_search_query' 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
• sqldatabase query->query()called directly
• querycontent queryget_terms()one call below WP_REST_Term_Search_Handler::search_items()

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 · 1 distinct outcome

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

Hooks and filters fired · 1

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

1. 1
   apply_filters( rest_term_search_query )filterline 91 (+38 into the body)

   Filters the query arguments for a REST API term search request.

Uses · 4

• apply_filters()Calls the callback functions that have been added to a filter hook.
• wp_list_pluck()Plucks a certain field out of each object or array in an array.
• wp_count_terms()Counts how many terms are in taxonomy.
• WP_Term_Query::__construct()Constructor.

Source code

View on Trac ↗View on GitHub ↗

53	public function search_items( WP_REST_Request $request ) {54		$taxonomies = $request[ WP_REST_Search_Controller::PROP_SUBTYPE ];55		if ( in_array( WP_REST_Search_Controller::TYPE_ANY, $taxonomies, true ) ) {56			$taxonomies = $this->subtypes;57		}58 59		$page     = (int) $request['page'];60		$per_page = (int) $request['per_page'];61 62		$query_args = array(63			'taxonomy'   => $taxonomies,64			'hide_empty' => false,65			'offset'     => ( $page - 1 ) * $per_page,66			'number'     => $per_page,67		);68 69		if ( ! empty( $request['search'] ) ) {70			$query_args['search'] = $request['search'];71		}72 73		if ( ! empty( $request['exclude'] ) ) {74			$query_args['exclude'] = $request['exclude'];75		}76 77		if ( ! empty( $request['include'] ) ) {78			$query_args['include'] = $request['include'];79		}80 81		/**82		 * Filters the query arguments for a REST API term search request.83		 *84		 * Enables adding extra arguments or setting defaults for a term search request.85		 *86		 * @since 5.6.087		 *88		 * @param array           $query_args Key value array of query var to query value.89		 * @param WP_REST_Request $request    The request used.90		 */91		$query_args = apply_filters( 'rest_term_search_query', $query_args, $request );92 93		$query       = new WP_Term_Query();94		$found_terms = $query->query( $query_args );95		$found_ids   = wp_list_pluck( $found_terms, 'term_id' );96 97		unset( $query_args['offset'], $query_args['number'] );98 99		$total = wp_count_terms( $query_args );100 101		// wp_count_terms() can return a falsey value when the term has no children.102		if ( ! $total ) {103			$total = 0;104		}105 106		return array(107			self::RESULT_IDS   => $found_ids,108			self::RESULT_TOTAL => $total,109		);110	}

Changelog

Introduced in 5.6.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 6.7.7 tag, from src/wp-includes/rest-api/search/class-wp-rest-term-search-handler.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.