Filter hook 'rest_{$this->post_type}_query'

in WP Core File wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php at line 444

View Source

rest_{$this->post_type}_query

Filter Hook
Description
Filters WP_Query arguments when querying posts via the REST API. 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.

Hook Information

File Location wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php View on GitHub
Hook Type Filter
Line Number 444

Hook Parameters

Type Name Description
array $args Array of arguments for WP_Query.
WP_REST_Request $request The REST API request.

Usage Examples

Basic Usage
<?php
// Hook into rest_{$this->post_type}_query
add_filter('rest_{$this->post_type}_query', 'my_custom_filter', 10, 2);

function my_custom_filter($args, $request) {
    // Your custom filtering logic here
    return $args;
}

Source Code Context

wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php:444 - How this hook is used in WordPress core
<?php
 439  		 * @link https://developer.wordpress.org/reference/classes/wp_query/
 440  		 *
 441  		 * @param array           $args    Array of arguments for WP_Query.
 442  		 * @param WP_REST_Request $request The REST API request.
 443  		 */
 444  		$args       = apply_filters( "rest_{$this->post_type}_query", $args, $request );
 445  		$query_args = $this->prepare_items_query( $args, $request );
 446  
 447  		$posts_query  = new WP_Query();
 448  		$query_result = $posts_query->query( $query_args );
 449  

PHP Documentation

<?php
/**
		 * Filters WP_Query arguments when querying posts via the REST API.
		 *
		 * 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.
		 *
		 * @since 4.7.0
		 * @since 5.7.0 Moved after the `tax_query` query arg is generated.
		 *
		 * @link https://developer.wordpress.org/reference/classes/wp_query/
		 *
		 * @param array           $args    Array of arguments for WP_Query.
		 * @param WP_REST_Request $request The REST API request.
		 */
Quick Info
  • Hook Type: Filter
  • Parameters: 2
  • File: wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php
Related Hooks

Related hooks will be displayed here in future updates.