wppaste
WordPress

get_dashboard_blog(): WP_Site

Since
MU (3.0.0)
Source
wp-includes/ms-deprecated.php:26
Get the "dashboard blog", the blog where users without a blog edit their profile data.

Description

Dashboard blog functionality was removed in WordPress 3.1, replaced by the user admin.

Compatibility

Deprecated in WordPress 3.1.0. Use get_site()

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.

Return value

WP_Site
Current site object.

Performance profile

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

Reads stored settings via get_site_option(), cached per request but not free on a cold cache.

Scaling
Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions
14–18

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

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

  • optionnetwork optionget_site_option()called directly
  • hookthird-party callbacksdo_action()one call below get_dashboard_blog()

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

WhenInstructionsCalls it makes
always14_deprecated_function(), get_site_option(), get_site()
always18_deprecated_function(), get_site_option(), get_network(), get_site()

Across PHP versions

PHPCompiledExecutedBranchesNotes
8.6-dev2214–181
8.52214–181
8.42214–181
8.32214–181
8.22214–181
8.12214–1811 fewer instruction than PHP 7.4
7.42314–191

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

  • _deprecated_function()Marks a function as deprecated and inform when it has been used.
  • get_site_option()Retrieve an option value for the current network based on name of option.
  • get_site()Retrieves site data given a site ID or site object.
  • get_network()Retrieves network data given a network ID or network object.

Source code

View on Trac View on GitHub 

function get_dashboard_blog() {    _deprecated_function( __FUNCTION__, '3.1.0', 'get_site()' );    if ( $blog = get_site_option( 'dashboard_blog' ) ) {	    return get_site( $blog );    }     return get_site( get_network()->site_id );}

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.1.0
Deprecated. Use get_site()from the docblock
MU (3.0.0)
MU (3.0.0)from the docblock

About this page

Parsed data
Generated from the wordpress-develop 6.7.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.