Filters the network data before the query takes place.
Description
Return a non-null value to bypass WordPress' default network queries. The expected return type from this filter depends on the value passed in the request query vars: <ul> <li>When $this->query_vars['count'] is set, the filter should return the network count as an integer.</li> <li>When 'ids' === $this->query_vars['fields'], the filter should return an array of network IDs.</li> <li>Otherwise the filter should return an array of WP_Network objects.</li> </ul> Note that if the filter returns an array of network data, it will be assigned to the networks property of the current WP_Network_Query instance. Filtering functions that require pagination information are encouraged to set the found_networks and max_num_pages properties of the WP_Network_Query object, passed to the filter by reference. If WP_Network_Query does not perform a database query, it will not have enough information to generate these values itself.
Parameters
$network_dataarray|int|null
Return an array of network data to short-circuit WP's network query, the network count as an integer if $this->query_vars['count'] is set, or null to allow WP to run its normal queries.
$queryWP_Network_Query
The WP_Network_Query instance, passed by reference.
227<?php228*229*@paramarray|int|null$network_dataReturnanarrayofnetworkdatatoshort-circuitWP'snetworkquery,230*thenetworkcountasanintegerif`$this->query_vars['count']` is set,231 * or null to allow WP to run its normal queries.232 * @param WP_Network_Query $query The WP_Network_Query instance, passed by reference.233 */234 $network_data = apply_filters_ref_array( 'networks_pre_query', array( $network_data, &$this ) );235236 if ( null !== $network_data ) {237 if ( is_array( $network_data ) && ! $this->query_vars['count'] ) {238 $this->networks = $network_data;239 }240
History
Introduced in 5.2.0. Unchanged from 6.7.7 through 7.1.0.