wppaste
WordPress

wp_dashboard_site_health()

Since
5.4.0
Source
wp-admin/includes/dashboard.php:1958
Displays the Site Health Status widget.

Compatibility

WordPress
since 5.4.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.

Performance profile

How much work a call to wp_dashboard_site_health() 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_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
39–77

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

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

  • transienttransientget_transient()called directly
  • serializeserialisationjson_decode()called directly
  • hookthird-party callbacksapply_filters()one call below wp_dashboard_site_health()
  • cacheobject cachewp_cache_get()one call below wp_dashboard_site_health()
  • optionoption read or writeget_option()one call below wp_dashboard_site_health()

Further down the call graph this can also reach query. That is the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 8 distinct outcomes

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

WhenInstructionsCalls it makes
always39–54get_transient(), _e(), _e()
$get_issues !== false44–59get_transient(), json_decode(), _e(), _e()
$get_issues === false45–49get_transient(), _e(), __(), admin_url(), esc_url(), printf()
always50–54get_transient(), json_decode(), _e(), __(), admin_url(), esc_url(), printf()
$issues_total59–72get_transient(), _e(), _e(), _n(), admin_url(), esc_url(), printf()
$get_issues !== false && $issues_total64–77get_transient(), json_decode(), _e(), _e(), _n(), admin_url(), esc_url(), printf()
$issues_total65–67get_transient(), _e(), __(), admin_url(), esc_url(), printf(), _n(), admin_url(), esc_url(), printf()
$issues_total70–72get_transient(), json_decode(), _e(), __(), admin_url(), esc_url(), printf(), _n(), admin_url(), esc_url(), printf()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 121 instructions, 39–77 executed per call, 11 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 · 6

  • get_transient()Retrieves the value of a transient.
  • _e()Displays translated text.
  • __()Retrieves the translation of $text.
  • esc_url()Checks and cleans a URL.
  • admin_url()Retrieves the URL to the admin area for the current site.
  • _n()Translates and retrieves the singular or plural form based on the supplied number.

Source code

View on Trac View on GitHub 

function wp_dashboard_site_health() {	$get_issues = get_transient( 'health-check-site-status-result' ); 	$issue_counts = array(); 	if ( false !== $get_issues ) {		$issue_counts = json_decode( $get_issues, true );	} 	if ( ! is_array( $issue_counts ) || ! $issue_counts ) {		$issue_counts = array(			'good'        => 0,			'recommended' => 0,			'critical'    => 0,		);	} 	$issues_total = $issue_counts['recommended'] + $issue_counts['critical'];	?>	<div class="health-check-widget">		<div class="health-check-widget-title-section site-health-progress-wrapper loading hide-if-no-js">			<div class="site-health-progress">				<svg aria-hidden="true" focusable="false" width="100%" height="100%" viewBox="0 0 200 200" version="1.1" xmlns="http://www.w3.org/2000/svg">					<circle r="90" cx="100" cy="100" fill="transparent" stroke-dasharray="565.48" stroke-dashoffset="0"></circle>					<circle id="bar" r="90" cx="100" cy="100" fill="transparent" stroke-dasharray="565.48" stroke-dashoffset="0"></circle>				</svg>			</div>			<div class="site-health-progress-label">				<?php if ( false === $get_issues ) : ?>					<?php _e( 'No information yet&hellip;' ); ?>				<?php else : ?>					<?php _e( 'Results are still loading&hellip;' ); ?>				<?php endif; ?>			</div>		</div> 		<div class="site-health-details">			<?php if ( false === $get_issues ) : ?>				<p>					<?php					printf(						/* translators: %s: URL to Site Health screen. */						__( 'Site health checks will automatically run periodically to gather information about your site. You can also <a href="%s">visit the Site Health screen</a> to gather information about your site now.' ),						esc_url( admin_url( 'site-health.php' ) )					);					?>				</p>			<?php else : ?>				<p>					<?php if ( $issues_total <= 0 ) : ?>						<?php _e( 'Great job! Your site currently passes all site health checks.' ); ?>					<?php elseif ( 1 === (int) $issue_counts['critical'] ) : ?>						<?php _e( 'Your site has a critical issue that should be addressed as soon as possible to improve its performance and security.' ); ?>					<?php elseif ( $issue_counts['critical'] > 1 ) : ?>						<?php _e( 'Your site has critical issues that should be addressed as soon as possible to improve its performance and security.' ); ?>					<?php elseif ( 1 === (int) $issue_counts['recommended'] ) : ?>						<?php _e( 'Your site&#8217;s health is looking good, but there is still one thing you can do to improve its performance and security.' ); ?>					<?php else : ?>						<?php _e( 'Your site&#8217;s health is looking good, but there are still some things you can do to improve its performance and security.' ); ?>					<?php endif; ?>				</p>			<?php endif; ?> 			<?php if ( $issues_total > 0 && false !== $get_issues ) : ?>				<p>					<?php					printf(						/* translators: 1: Number of issues. 2: URL to Site Health screen. */						_n(							'Take a look at the <strong>%1$d item</strong> on the <a href="%2$s">Site Health screen</a>.',							'Take a look at the <strong>%1$d items</strong> on the <a href="%2$s">Site Health screen</a>.',							$issues_total						),						$issues_total,						esc_url( admin_url( 'site-health.php' ) )					);					?>				</p>			<?php endif; ?>		</div>

Changelog

Introduced in 5.4.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.8.8 tag, from src/wp-admin/includes/dashboard.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.