networks_pre_query WordPress Filter Hook
The networks_pre_query hook is called after the query has been compiled but before it is executed. It can be used to modify the query or to perform any other actions that need to happen before the query is executed.
apply_filters_ref_array( 'networks_pre_query', array|int|null $network_data , WP_Network_Query $query ) #
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:
- When
$this->query_vars['count']is set, the filter should return the network count as an integer. - When
'ids' === $this->query_vars['fields'], the filter should return an array of network IDs. - Otherwise the filter should return an array of WP_Network objects.
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_data
(array|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.- $query
(WP_Network_Query)The WP_Network_Query instance, passed by reference.
Source
Changelog
| Version | Description |
|---|---|
| 5.6.0 | The returned array of network data is assigned to the networks property of the current WP_Network_Query instance. |
| 5.2.0 | Introduced. |