wppaste
WordPress

apply_filters( "rest_{$this->taxonomy}_collection_params", array $query_params, WP_Taxonomy $taxonomy )

Since
4.7.0
Filters collection parameters for the terms controller.

Description

The dynamic part of the filter $this->taxonomy refers to the taxonomy slug for the controller.

This filter registers the collection parameter, but does not map the collection parameter to an internal WP_TermQuery parameter. Use the `rest{$this->taxonomy}_query` filter to set WP_Term_Query parameters.

Compatibility

WordPress
since 4.7.0
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0).

Parameters

$query_paramsarray
JSON Schema-formatted collection parameters.
$taxonomyWP_Taxonomy
Taxonomy object.

Where this hook fires · 1

  • wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php:1229WP_REST_Terms_Controller::get_collection_params()

Source code

View on Trac View on GitHub 

		 *		 * @since 4.7.0		 *		 * @param array       $query_params JSON Schema-formatted collection parameters.		 * @param WP_Taxonomy $taxonomy     Taxonomy object.		 */		return apply_filters( "rest_{$this->taxonomy}_collection_params", $query_params, $taxonomy );	} 	/**	 * Checks that the taxonomy is valid.	 *	 * @since 4.7.0

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