WP_REST_Block_Directory_Controller::get_collection_params(): array

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

array

Collection parameters.

Performance profile

How much work a call to WP_REST_Block_Directory_Controller::get_collection_params() 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

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

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

Instructions

21

Executed per call on PHP 8.5. The body compiles to 21.

Plugin surface

1 hook

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

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly

Further down the call graph this can also reach query, 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_Block_Directory_Controller::get_collection_params() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

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

1. 1
   apply_filters( rest_block_directory_collection_params )filterline 326 (+21 into the body)

   Filters REST API collection parameters for the block directory controller.

Uses · 3

• __()Retrieves the translation of $text.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• WP_REST_Controller::get_collection_params()Retrieves the query params for the collections.

Used by · 1

• WP_REST_Block_Directory_Controller::register_routes()Registers the necessary REST API routes.

Source code

View on Trac ↗View on GitHub ↗

305	public function get_collection_params() {306		$query_params = parent::get_collection_params();307 308		$query_params['context']['default'] = 'view';309 310		$query_params['term'] = array(311			'description' => __( 'Limit result set to blocks matching the search term.' ),312			'type'        => 'string',313			'required'    => true,314			'minLength'   => 1,315		);316 317		unset( $query_params['search'] );318 319		/**320		 * Filters REST API collection parameters for the block directory controller.321		 *322		 * @since 5.5.0323		 *324		 * @param array $query_params JSON Schema-formatted collection parameters.325		 */326		return apply_filters( 'rest_block_directory_collection_params', $query_params );327	}

Changelog

Introduced in 5.5.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-includes/rest-api/endpoints/class-wp-rest-block-directory-controller.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.