A WordPress-centric search engine for devs and theme authors



sites_pre_query ›

Since5.2.0
Deprecatedn/a
apply_filters_ref_array( 'sites_pre_query', array( $site_data, &$this )
Parameters: (2)
  • (array|int|null) $site_data 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.
    Required: Yes
  • (WP_Site_Query) $this The WP_Site_Query instance, passed by reference.
    Required: Yes
Defined at:
Codex:

Filter the site data before the get_sites query takes place.

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.





Source

$site_data = apply_filters_ref_array( 'sites_pre_query', array( $site_data, &$this ) );