W3cubDocs

/WordPress

apply_filters_ref_array( 'sites_pre_query', array|int|null $site_data, WP_Site_Query $this )

Filter the site data before the get_sites query takes place.

Description

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

The expected return type from this filter depends on the value passed in the request query_vars: When $this->query_vars['count'] is set, the filter should return the site count as an int. When 'ids' === $this->query_vars['fields'], the filter should return an array of site IDs. Otherwise the filter should return an array of WP_Site objects.

Parameters

$site_data

(array|int|null) Return an array of site data to short-circuit WP's site query, the site count as an integer if $this->query_vars['count'] is set, or null to run the normal queries.

$this

(WP_Site_Query) The WP_Site_Query instance, passed by reference.

Source

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

View on Trac

Used By

Used By Description
wp-includes/class-wp-site-query.php: WP_Site_Query::get_sites()

Retrieves a list of sites matching the query vars.

Changelog

Version Description
5.2.0 Introduced.

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