apply_filters( "rest_{$this->post_type}_query", array $args, WP_REST_Request $request )

Filters the query arguments for a request.


Description Description

Enables adding extra arguments or setting defaults for a post collection request.


Parameters Parameters

$args

(array) Key value array of query var to query value.

$request

(WP_REST_Request) The request used.


Top ↑

Source Source

File: wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php

View on Trac


Top ↑

Changelog Changelog

Changelog
Version Description
4.7.0 Introduced.


Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note 1 content
    Contributed by Haris

    Code example:

    function query_book_by_year($args, $request) {
    	if(isset($request["year"]) && intval($request["year"]) > 1500) {
    		$args['meta_key'] = 'year';
    		$args['meta_value'] = intval($request["year"]);
    	}		
    
    	return $args;
    }
    add_filter('rest_book_query', 'query_book_by_year', 10, 2);
    

You must log in before being able to contribute a note or feedback.