get_sites( string|array $args = array() ): WP_Site[]|int[]|int
- Since
- 4.6.0, 4.8.0
- Source
wp-includes/ms-site.php:445
Compatibility
- WordPress
- since 4.8.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$argsstring|arrayoptional- Array or string of arguments. See WP_Site_Query::__construct() for information on accepted arguments. Default empty array.Default:
array()
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 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
- Trivial
- Scaling
- Constant
- Instructions
- 8
- Plugin surface
- None
- Called by
- 11
Reaches the database via ->query().
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5. The body compiles to 8.
Nothing here hands control to plugin code.
11 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- sqldatabase query
->query()called directly
What one call costs · 1 distinct outcome
One number would be a lie: the work depends on which branch runs. These are every distinct cost get_sites() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 8 | ->query() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 8 instructions, 8 executed per call, 0 branches. The work does not change between versions.
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 1
- WP_Site_Query::__construct()Sets up the site query, based on the query vars passed.
Used by · 11
- WP_Importer::set_blog()
- WP_MS_Sites_List_Table::prepare_items()Prepares the list of sites for display.
- WP_Network::get_main_site_id()Returns the main site ID for the network.
- domain_exists()Checks whether a site name is already taken.
- get_blog_id_from_url()Gets a blog's numeric ID from its URL.
- get_blogs_of_user()Gets the sites a user belongs to.
- get_id_from_blogname()Retrieves a site's ID given its (subdomain or directory) slug.
- get_oembed_response_data_for_url()Retrieves the oEmbed response data for a given URL.
- get_site_by_path()Retrieves the closest matching site object by its domain and path.
- wp_get_sites()Return an array of sites for a network or networks.
- wp_update_network_site_counts()Updates the network-wide site count.
Source code
function get_sites( $args = array() ) { $query = new WP_Site_Query(); return $query->query( $args );}Changelog
Introduced in 4.8.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.0.4 tag, from
src/wp-includes/ms-site.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.