get_sites( string|array $args = array() ): WP_Site[]|int[]|int

Parameters

$argsstring|arrayoptional

Array or string of arguments. See WP_Site_Query::__construct() for information on accepted arguments. Default empty array.Default: array()

Return

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.

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

View on Trac ↗View on GitHub ↗

445function get_sites( $args = array() ) {446	$query = new WP_Site_Query();447 448	return $query->query( $args );449}

History

Introduced in 4.8.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 6.9.7 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.