W3cubDocs

/WordPress

apply_filters_ref_array( 'posts_pre_query', array|null $posts, WP_Query $this )

Filters the posts array before the query takes place.

Description

Return a non-null value to bypass WordPress’s default post queries.

Filtering functions that require pagination information are encouraged to set the found_posts and max_num_pages properties of the WP_Query object, passed to the filter by reference. If WP_Query does not perform a database query, it will not have enough information to generate these values itself.

Parameters

$posts

(array|null) Return an array of post data to short-circuit WP's query, or null to allow WP to run its normal queries.

$this

(WP_Query) The WP_Query instance (passed by reference).

Source

File: wp-includes/class-wp-query.php

View on Trac

Used By

Used By Description
wp-includes/class-wp-query.php: WP_Query::get_posts()

Retrieves an array of posts based on query variables.

Changelog

Version Description
4.6.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/hooks/posts_pre_query