get_sites( string|array $args = array() ): array|int

Retrieves a list of sites matching requested arguments.

Contents

Description

Top ↑

See also

Top ↑

Parameters

$args string|array Optional
Array or string of arguments. See WP_Site_Query::__construct() for information on accepted arguments.
More Arguments from WP_Site_Query::__construct( ... $query ) Array or query string of site query parameters.
  • site__in int[]
    Array of site IDs to include.
  • site__not_in int[]
    Array of site IDs to exclude.
  • count bool
    Whether to return a site count (true) or array of site objects.
    Default false.
  • date_query array
    Date query clauses to limit sites by. See WP_Date_Query.
    Default null.
  • fields string
    Site fields to return. Accepts 'ids' (returns an array of site IDs) or empty (returns an array of complete site objects).
  • ID int
    A site ID to only return that site.
  • number int
    Maximum number of sites to retrieve. Default 100.
  • offset int
    Number of sites to offset the query. Used to build LIMIT clause.
    Default 0.
  • no_found_rows bool
    Whether to disable the SQL_CALC_FOUND_ROWS query. Default true.
  • orderby string|array
    Site status or array of statuses. Accepts:
    • 'id'
    • 'domain'
    • 'path'
    • 'network_id'
    • 'last_updated'
    • 'registered'
    • 'domain_length'
    • 'path_length'
    • 'site__in'
    • 'network__in'
    • 'deleted'
    • 'mature'
    • 'spam'
    • 'archived'
    • 'public'
    • false, an empty array, or 'none' to disable ORDER BY clause.
    Default 'id'.
  • order string
    How to order retrieved sites. Accepts 'ASC', 'DESC'. Default 'ASC'.
  • network_id int
    Limit results to those affiliated with a given network ID. If 0, include all networks. Default 0.
  • network__in int[]
    Array of network IDs to include affiliated sites for.
  • network__not_in int[]
    Array of network IDs to exclude affiliated sites for.
  • domain string
    Limit results to those affiliated with a given domain.
  • domain__in string[]
    Array of domains to include affiliated sites for.
  • domain__not_in string[]
    Array of domains to exclude affiliated sites for.
  • path string
    Limit results to those affiliated with a given path.
  • path__in string[]
    Array of paths to include affiliated sites for.
  • path__not_in string[]
    Array of paths to exclude affiliated sites for.
  • public int
    Limit results to public sites. Accepts '1' or '0'.
  • archived int
    Limit results to archived sites. Accepts '1' or '0'.
  • mature int
    Limit results to mature sites. Accepts '1' or '0'.
  • spam int
    Limit results to spam sites. Accepts '1' or '0'.
  • deleted int
    Limit results to deleted sites. Accepts '1' or '0'.
  • lang_id int
    Limit results to a language ID.
  • lang__in string[]
    Array of language IDs to include affiliated sites for.
  • lang__not_in string[]
    Array of language IDs to exclude affiliated sites for.
  • search string
    Search term(s) to retrieve matching sites for.
  • search_columns string[]
    Array of column names to be searched. Accepts 'domain' and 'path'.
    Default empty array.
  • update_site_cache bool
    Whether to prime the cache for found sites. Default true.
  • update_site_meta_cache bool
    Whether to prime the metadata cache for found sites. Default true.
  • meta_key string|string[]
    Meta key or keys to filter by.
  • meta_value string|string[]
    Meta value or values to filter by.
  • meta_compare string
    MySQL operator used for comparing the meta value.
    See WP_Meta_Query::__construct() for accepted values and default value.
  • meta_compare_key string
    MySQL operator used for comparing the meta key.
    See WP_Meta_Query::__construct() for accepted values and default value.
  • meta_type string
    MySQL data type that the meta_value column will be CAST to for comparisons.
    See WP_Meta_Query::__construct() for accepted values and default value.
  • meta_type_key string
    MySQL data type that the meta_key column will be CAST to for comparisons.
    See WP_Meta_Query::__construct() for accepted values and default value.
  • meta_query array
    An associative array of WP_Meta_Query arguments.
    See WP_Meta_Query::__construct() for accepted values.

Default: array()

Top ↑

Return

array|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.

Top ↑

Source

File: wp-includes/ms-site.php. View all references 

function get_sites( $args = array() ) {
	$query = new WP_Site_Query();

	return $query->query( $args );
}

View on Trac View on GitHub

Top ↑

Top ↑

Used By

Used By
Used By Description
get_oembed_response_data_for_url() wp-includes/embed.php

Retrieves the oEmbed response data for a given URL.
WP_Network::get_main_site_id() wp-includes/class-wp-network.php

Returns the main site ID for the network.
WP_MS_Sites_List_Table::prepare_items() wp-admin/includes/class-wp-ms-sites-list-table.php

Prepares the list of sites for display.
WP_Importer::set_blog() wp-admin/includes/class-wp-importer.php
get_blogs_of_user() wp-includes/user.php

Gets the sites a user belongs to.
wp_get_sites() wp-includes/ms-deprecated.php

Return an array of sites for a network or networks.
wp_update_network_site_counts() wp-includes/ms-functions.php

Updates the network-wide site count.
domain_exists() wp-includes/ms-functions.php

Checks whether a site name is already taken.
get_blog_id_from_url() wp-includes/ms-functions.php

Gets a blog’s numeric ID from its URL.
get_site_by_path() wp-includes/ms-load.php

Retrieves the closest matching site object by its domain and path.
get_id_from_blogname() wp-includes/ms-blogs.php

Retrieves a site’s ID given its (subdomain or directory) slug.
Show 6 more used by Hide more used by

Top ↑

Changelog

Changelog
Version Description
4.8.0 Introduced the 'lang_id', 'lang__in', and 'lang__not_in' parameters.
4.6.0 Introduced.

Top ↑

User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 9You must log in to vote on the helpfulness of this note
    Contributed by Store Locator Plus —

    Also good to know… get_sites now returns an OBJECT not a named array.

    A code example that may help:

    // WordPress 4.6
//
if ( function_exists( 'get_sites' ) && class_exists( 'WP_Site_Query' ) ) {
	$sites = get_sites();
	foreach ( $sites as $site ) {
		switch_to_blog( $site->blog_id );
                // do something
		restore_current_blog();
	}
	return;
}

// WordPress < 4.6
//
if ( function_exists( 'wp_get_sites' ) ) {
	$sites = wp_get_sites();
	foreach ( $sites as $site ) {
		switch_to_blog( $site['blog_id'] );
                // do something
		restore_current_blog();
	}
	return;
}
  2. Skip to note 2 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 5You must log in to vote on the helpfulness of this note
    Contributed by mkormendy —

    Beware, using get_sites() as a drop-in for wp_get_sites() may not produce results as expected.

    PHP Fatal error: Cannot use object of type WP_Site as array in /path/to/code/that/uses/get_sites/method/file.php

    It’s true that get_sites() returns an array, however, it produces an array of sites as objects. This is different from wp_get_sites(), which used to produce a multidimensional array of the sites, with their properties in a secondary array dimension (simply an array of site arrays with that site’s properties).

    If you’re attempting to loop through the sites to get the properties of each site with get_sites(), you’ll need to convert each site object to an array using get_object_vars( object ) http://www.php.net/manual/en/function.get-object-vars.php.

    See the example below noting the use of get_object_vars on line three:

    $subsites = get_sites();
foreach( $subsites as $subsite ) {
  $subsite_id = get_object_vars($subsite)["blog_id"];
  $subsite_name = get_blog_details($subsite_id)->blogname;
  echo 'Site ID/Name: ' . $subsite_id . ' / ' . $subsite_name . '\n';
}

    This should return the following list of sites:

    Site ID/Name: 1 / SiteNameOne
    Site ID/Name: 2 / SiteNameTwo
    Site ID/Name: 3 / SiteNameThree

  3. Skip to note 3 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note
    Contributed by Store Locator Plus —

    wp_get_sites() ‘limit’ argument is now ‘number’.

    wp_get_sites() converted this to $args[‘number’] for you, get_sites() does not appear to handle this parameter name conversion for you.

    Reference: https://developer.wordpress.org/reference/functions/wp_get_sites/

You must log in before being able to contribute a note or feedback.