WP_Site_Query::get_sites(): WP_Site[]|int[]|int

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Return value

WP_Site[]|int[]|int

List of WP_Site objects, a list of site IDs when 'fields' is set to 'ids', or the number of sites when 'count' is passed as a query var.

Performance profile

How much work a call to WP_Site_Query::get_sites() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Moderate

Only touches the object cache, via wp_cache_get_last_changed().

Scaling

Scales with input

The body loops, so the work grows with how much data it finds.

Instructions

41–161

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 187.

Plugin surface

3 hooks

Third-party callbacks on 'pre_get_sites', 'sites_pre_query', 'the_sites' run inside this call, and their cost is not bounded by anything here.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksdo_action_ref_array()called directly
• cacheobject cachewp_cache_get_last_changed()called directly
• serializeserialisationserialize()called directly

What one call costs · 86 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Site_Query::get_sites() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 3

3 hooks fire while WP_Site_Query::get_sites() runs, in this order:

1. 1
   do_action( pre_get_sites )actionline 301 (+16 into the body)

   Fires before sites are retrieved.

2. 2
   apply_filters( sites_pre_query )filterline 341 (+56 into the body)

   Filters the site data before the get_sites query takes place.

3. 3
   apply_filters( the_sites )filterline 423 (+138 into the body)

   Filters the site query results.

Uses · 13

• do_action_ref_array()Calls the callback functions that have been added to an action hook, specifying arguments in an array.
• apply_filters_ref_array()Calls the callback functions that have been added to a filter hook, specifying arguments in an array.
• wp_array_slice_assoc()Extracts a slice of an array, given a list of keys.
• wp_cache_get_last_changed()Gets last changed date for the specified cache group.
• wp_cache_get_salted()Retrieves cached data if valid and unchanged.
• wp_cache_set_salted()Stores salted data in the cache.
• wp_lazyload_site_meta()Queue site meta for lazy-loading.
• _prime_site_caches()Adds any sites from the given IDs to the cache that do not already exist in cache.
• get_site()Retrieves site data given a site ID or site object.
• WP_Site_Query::parse_query()Parses arguments passed to the site query with default query parameters.
• WP_Meta_Query::__construct()Constructor.
• WP_Site_Query::get_site_ids()Used internally to get a list of site IDs matching the query vars.

Used by · 1

• WP_Site_Query::query()Sets up the WordPress query for retrieving sites.

Changelog

Introduced in 4.6.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/class-wp-site-query.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.