wppaste
WordPress

get_most_active_blogs( int $num = 10, bool $display = true ): array

Since
MU (3.0.0)
Source
wp-includes/ms-deprecated.php:223
Deprecated functionality to retrieve a list of the most active sites.

Compatibility

Deprecated in WordPress 3.0.0. Kept for back-compatibility; avoid it in new code.

WordPress
since MU (3.0.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

$numintoptional
Number of activate blogs to retrieve. Default 10.Default: 10
$displaybooloptional
Whether or not to display the most active blogs list. Default true.Default: true

Return value

array
List of "most active" sites.

Performance profile

How much work a call to get_most_active_blogs() 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
21–52

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

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 get_most_active_blogs()

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 · 4 distinct outcomes

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

WhenInstructionsCalls it makes
!is_array($blogs)21–23_deprecated_function(), get_blog_list(), array_slice()
!is_array($blogs) && is_array($most_active)29–30_deprecated_function(), get_blog_list(), reset(), array_slice()
is_array($blogs)41–45_deprecated_function(), get_blog_list(), reset(), arsort(), reset(), array_slice()
is_array($blogs) && is_array($most_active)49–52_deprecated_function(), get_blog_list(), reset(), arsort(), reset(), reset(), array_slice()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 85 instructions, 21–52 executed per call, 9 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 · 3

Source code

function get_most_active_blogs( $num = 10, $display = true ) {	_deprecated_function( __FUNCTION__, '3.0.0' ); 	$blogs = get_blog_list( 0, 'all', false ); // $blog_id -> $details	if ( is_array( $blogs ) ) {		reset( $blogs );		$most_active = array();		$blog_list = array();		foreach ( (array) $blogs as $key => $details ) {			$most_active[ $details['blog_id'] ] = $details['postcount'];			$blog_list[ $details['blog_id'] ] = $details; // array_slice() removes keys!		}		arsort( $most_active );		reset( $most_active );		$t = array();		foreach ( (array) $most_active as $key => $details ) {			$t[ $key ] = $blog_list[ $key ];		}		unset( $most_active );		$most_active = $t;	} 	if ( $display ) {		if ( is_array( $most_active ) ) {			reset( $most_active );			foreach ( (array) $most_active as $key => $details ) {				$url = esc_url('http://' . $details['domain'] . $details['path']);				echo '<li>' . $details['postcount'] . " <a href='$url'>$url</a></li>";			}		}	}	return array_slice( $most_active, 0, $num );}

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.

3.0.0
Deprecated.from the docblock
MU (3.0.0)
MU (3.0.0)from the docblock

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.