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_query
rest_page_query
rest_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. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.
Code example:
I wanted to see the SQL generated from the filters I’ve added. However, using
&debug=sql
on the http request parameter didn’t work for me.You can set a breakpoint at line 299 (at least at the time of writing) under
class-wp-rest-posts-controller.php@get_items()
method, which looks like this:Or if you don’t have a debugger setup yet, you can do: