wpseek.com
A WordPress-centric search engine for devs and theme authors
sites_pre_query › WordPress Filter Hooks
Since5.6.0
Deprecatedn/a
› apply_filters_ref_array( 'sites_pre_query', array( $site_data, &$this )
Parameters: (2) |
|
Defined at: |
|
Codex: |
Filters the site data before the get_sites query takes place.
Return a non-null value to bypass WordPress' 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 integer. - 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.
Note that if the filter returns an array of site data, it will be assigned
to the sites
property of the current WP_Site_Query instance.
Filtering functions that require pagination information are encouraged to set
the found_sites
and max_num_pages
properties of the WP_Site_Query object,
passed to the filter by reference. If WP_Site_Query does not perform a database
query, it will not have enough information to generate these values itself.
Related Functions: the_search_query, is_main_query, wp_reset_query, sanitize_title_for_query, site_url, register_block_core_query
Related Hooks: terms_pre_query, networks_pre_query, found_sites_query, parse_term_query, parse_site_query