WP_REST_Posts_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_Posts_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

189–270

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

Plugin surface

1 hook

Third-party callbacks on 'rest_{$this->post_type}_collection_params' run inside this call, and their cost is not bounded by anything here.

Called by

6

6 places 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 · 96 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_REST_Posts_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_Posts_Controller::get_collection_params() runs, in this order:

1. 1
   apply_filters( rest_{$this->post_type}_collection_params )filterline 3179 (+205 into the body)

   Filters collection parameters for the posts controller.

Uses · 8

• __()Retrieves the translation of $text.
• post_type_supports()Checks a post type's support for a given feature.
• get_post_type_object()Retrieves a post type object by name.
• get_post_stati()Gets a list of post statuses.
• get_post_format_slugs()Retrieves the array of post format slugs.
• 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.
• WP_REST_Posts_Controller::prepare_taxonomy_limit_schema()Prepares the collection schema for including and excluding items by terms.

Used by · 6

• WP_REST_Attachments_Controller::get_collection_params()Retrieves the query params for collections of attachments.
• WP_REST_Font_Faces_Controller::get_collection_params()Retrieves the query params for the font face collection.
• WP_REST_Font_Families_Controller::get_collection_params()Retrieves the query params for the font family collection.
• WP_REST_Menu_Items_Controller::get_collection_params()Retrieves the query params for the nav menu items collection.
• WP_REST_Posts_Controller::get_items()Retrieves a collection of posts.
• WP_REST_Posts_Controller::register_routes()Registers the routes for posts.

Source code

View on Trac ↗View on GitHub ↗

2974	public function get_collection_params() {2975		$query_params = parent::get_collection_params();2976 2977		$query_params['context']['default'] = 'view';2978 2979		$query_params['after'] = array(2980			'description' => __( 'Limit response to posts published after a given ISO8601 compliant date.' ),2981			'type'        => 'string',2982			'format'      => 'date-time',2983		);2984 2985		$query_params['modified_after'] = array(2986			'description' => __( 'Limit response to posts modified after a given ISO8601 compliant date.' ),2987			'type'        => 'string',2988			'format'      => 'date-time',2989		);2990 2991		if ( post_type_supports( $this->post_type, 'author' ) ) {2992			$query_params['author']         = array(2993				'description' => __( 'Limit result set to posts assigned to specific authors.' ),2994				'type'        => 'array',2995				'items'       => array(2996					'type' => 'integer',2997				),2998				'default'     => array(),2999			);3000			$query_params['author_exclude'] = array(3001				'description' => __( 'Ensure result set excludes posts assigned to specific authors.' ),3002				'type'        => 'array',3003				'items'       => array(3004					'type' => 'integer',3005				),3006				'default'     => array(),3007			);3008		}3009 3010		$query_params['before'] = array(3011			'description' => __( 'Limit response to posts published before a given ISO8601 compliant date.' ),3012			'type'        => 'string',3013			'format'      => 'date-time',3014		);3015 3016		$query_params['modified_before'] = array(3017			'description' => __( 'Limit response to posts modified before a given ISO8601 compliant date.' ),3018			'type'        => 'string',3019			'format'      => 'date-time',3020		);3021 3022		$query_params['exclude'] = array(3023			'description' => __( 'Ensure result set excludes specific IDs.' ),3024			'type'        => 'array',3025			'items'       => array(3026				'type' => 'integer',3027			),3028			'default'     => array(),3029		);3030 3031		$query_params['include'] = array(3032			'description' => __( 'Limit result set to specific IDs.' ),3033			'type'        => 'array',3034			'items'       => array(3035				'type' => 'integer',3036			),3037			'default'     => array(),3038		);3039 3040		if ( 'page' === $this->post_type || post_type_supports( $this->post_type, 'page-attributes' ) ) {3041			$query_params['menu_order'] = array(3042				'description' => __( 'Limit result set to posts with a specific menu_order value.' ),3043				'type'        => 'integer',3044			);3045		}3046 3047		$query_params['search_semantics'] = array(3048			'description' => __( 'How to interpret the search input.' ),3049			'type'        => 'string',3050			'enum'        => array( 'exact' ),3051		);3052 3053		$query_params['offset'] = array(

Changelog

Introduced in 4.7.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-posts-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.