rest_{$this->post_type}_collection_params

Advertisement

Summery Summery

Filter collection parameters for the posts controller.

Syntax Syntax

apply_filters( "rest_{$this->post_type}_collection_params", array $query_params, WP_Post_Type $post_type )

Description Description

The dynamic part of the filter $this->post_type refers to the post type slug for the controller.

This filter registers the collection parameter, but does not map the collection parameter to an internal WP_Query parameter. Use the `rest_{$this->post_type}_query` filter to set WP_Query parameters.

Parameters Parameters

$query_params

(array) JSON Schema-formatted collection parameters.

$post_type

(WP_Post_Type) Post type object.

Source Source

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

Advertisement

Changelog Changelog

Changelog
Version Description
4.7.0 Introduced.

Advertisement

Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.