apply_filters( "rest_query_var-{$key}", string $value )
- Since
- 4.7.0
Filters the query_vars used in get_items() for the constructed query.
Description
The dynamic portion of the hook name, $key, refers to the query_var key.
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
$valuestring- The query_var value.
Where this hook fires · 2
wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php:1200WP_REST_Posts_Controller::prepare_items_query()wp-includes/rest-api/endpoints/class-wp-rest-revisions-controller.php:537WP_REST_Revisions_Controller::prepare_items_query()
Source code
* The dynamic portion of the hook name, `$key`, refers to the query_var key. * * @since 4.7.0 * * @param string $value The query_var value. */ $query_args[ $key ] = apply_filters( "rest_query_var-{$key}", $value ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores } if ( 'post' !== $this->post_type || ! isset( $query_args['ignore_sticky_posts'] ) ) { $query_args['ignore_sticky_posts'] = true; }Changelog
Introduced in 4.7.0. Unchanged from 6.7.7 through 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, 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.