get_blog_list( int $start = 0, int $num = 10, string $deprecated = '' )

Compatibility

Deprecated in WordPress 3.0.0. Use wp_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

$startintoptional

Offset for retrieving the blog list. Default 0.Default: 0

$numintoptional

Number of blogs to list. Default 10.Default: 10

$deprecatedstringoptional

Unused.Default: ''

Performance profile

How much work a call to get_blog_list() 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

Heavy

Reaches the database via ->get_results().

Scaling

Scales with input

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

Instructions

31–40

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

1

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

What it touches

• sqldatabase query->get_results()called directly
• hookthird-party callbacksdo_action()one call below get_blog_list()

Further down the call graph this can also reach query, option, cache, serialize 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 get_blog_list() can have, taken from its control-flow graph on PHP 8.5.

Uses · 2

• _deprecated_function()Marks a function as deprecated and inform when it has been used.
• get_current_network_id()Retrieves the current network ID.

Used by · 1

• get_most_active_blogs()Deprecated functionality to retrieve a list of the most active sites.

Source code

View on Trac ↗View on GitHub ↗

190function get_blog_list( $start = 0, $num = 10, $deprecated = '' ) {191	_deprecated_function( __FUNCTION__, '3.0.0', 'wp_get_sites()' );192 193	global $wpdb;194	$blogs = $wpdb->get_results( $wpdb->prepare( "SELECT blog_id, domain, path FROM $wpdb->blogs WHERE site_id = %d AND public = '1' AND archived = '0' AND mature = '0' AND spam = '0' AND deleted = '0' ORDER BY registered DESC", get_current_network_id() ), ARRAY_A );195 196	$blog_list = array();197	foreach ( (array) $blogs as $details ) {198		$blog_list[ $details['blog_id'] ] = $details;199		$blog_list[ $details['blog_id'] ]['postcount'] = $wpdb->get_var( "SELECT COUNT(ID) FROM " . $wpdb->get_blog_prefix( $details['blog_id'] ). "posts WHERE post_status='publish' AND post_type='post'" );200	}201 202	if ( ! $blog_list ) {203		return array();204	}205 206	if ( 'all' === $num ) {207		return array_slice( $blog_list, $start, count( $blog_list ) );208	} else {209		return array_slice( $blog_list, $start, $num );210	}211}

Changelog

Introduced in MU (3.0.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/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.