rest_{$this->post_type}_query WordPress Filter Hook
The rest_{$this->post_type}_query hook is used to modify the WP_Query object before it is executed. This is useful for modifying the query arguments, or for adding extra security checks.
apply_filters( "rest_{$this->post_type}_query", array $args , WP_REST_Request $request ) #
Filters WP_Query arguments when querying posts via the REST API.
Description
The dynamic portion of the hook name, $this->post_type, refers to the post type slug.
Possible hook names include:
rest_post_queryrest_page_queryrest_attachment_query
Enables adding extra arguments or setting defaults for a post collection request.
Parameters
- $args
(array)Array of arguments for WP_Query.
- $request
(WP_REST_Request)The REST API request.
Source
File: wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php
Changelog
| Version | Description |
|---|---|
| 5.7.0 | Moved after the tax_query query arg is generated. |
| 4.7.0 | Introduced. |