wp_get_sites( array $args = array() ): array[]

Compatibility

Deprecated in WordPress 4.6.0. Use get_sites()

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

Parameters

$argsarrayoptional

Array of default arguments. Optional.Default: array()

• $network_idint|int[]

  A network ID or array of network IDs. Set to null to retrieve sites from all networks. Defaults to current network ID.

• $publicintdefault: null, for any

  Retrieve public or non-public sites.

• $archivedintdefault: null, for any

  Retrieve archived or non-archived sites.

• $matureintdefault: null, for any

  Retrieve mature or non-mature sites.

• $spamintdefault: null, for any

  Retrieve spam or non-spam sites.

• $deletedintdefault: null, for any

  Retrieve deleted or non-deleted sites.

• $limitintdefault: 100

  Number of sites to limit the query to.

• $offsetintdefault: 0

  Exclude the first x sites. Used in combination with the $limit parameter.

Return value

array[]

An empty array if the installation is considered "large" via wp_is_large_network(). Otherwise, an associative array of WP_Site data as arrays.

Performance profile

How much work a call to wp_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

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

10–53

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksdo_action()one call below wp_get_sites()

Further down the call graph this can also reach option, cache, serialize, query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 2 distinct outcomes

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

Uses · 6

• _deprecated_function()Marks a function as deprecated and inform when it has been used.
• wp_is_large_network()Determines whether or not we have a large network.
• get_current_network_id()Retrieves the current network ID.
• wp_parse_args()Merges user defined arguments into defaults array.
• get_sites()Retrieves a list of sites matching requested arguments.
• get_site()Retrieves site data given a site ID or site object.

Source code

View on Trac ↗View on GitHub ↗

482function wp_get_sites( $args = array() ) {483	_deprecated_function( __FUNCTION__, '4.6.0', 'get_sites()' );484 485	if ( wp_is_large_network() )486		return array();487 488	$defaults = array(489		'network_id' => get_current_network_id(),490		'public'     => null,491		'archived'   => null,492		'mature'     => null,493		'spam'       => null,494		'deleted'    => null,495		'limit'      => 100,496		'offset'     => 0,497	);498 499	$args = wp_parse_args( $args, $defaults );500 501	// Backward compatibility.502	if( is_array( $args['network_id'] ) ){503		$args['network__in'] = $args['network_id'];504		$args['network_id'] = null;505	}506 507	if( is_numeric( $args['limit'] ) ){508		$args['number'] = $args['limit'];509		$args['limit'] = null;510	} elseif ( ! $args['limit'] ) {511		$args['number'] = 0;512		$args['limit'] = null;513	}514 515	// Make sure count is disabled.516	$args['count'] = false;517 518	$_sites  = get_sites( $args );519 520	$results = array();521 522	foreach ( $_sites as $_site ) {523		$_site = get_site( $_site );524		$results[] = $_site->to_array();525	}526 527	return $results;528}

Changelog

Introduced in 3.7.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-deprecated.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.