WP_Site_Health_Auto_Updates::test_if_failed_update(): array|false

Compatibility

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

Return value

array|false

The test results if auto-updates previously failed, false otherwise.

Performance profile

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

6–38

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

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

• optionnetwork optionget_site_option()called directly

Further down the call graph this can also reach hook, 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 · 3 distinct outcomes

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

Uses · 2

• get_site_option()Retrieve an option value for the current network based on name of option.
• __()Retrieves the translation of $text.

Used by · 1

• WP_Site_Health_Auto_Updates::run_tests()Runs tests to determine if auto-updates can run.

Source code

View on Trac ↗View on GitHub ↗

170	public function test_if_failed_update() {171		$failed = get_site_option( 'auto_core_update_failed' );172 173		if ( ! $failed ) {174			return false;175		}176 177		if ( ! empty( $failed['critical'] ) ) {178			$description  = __( 'A previous automatic background update ended with a critical failure, so updates are now disabled.' );179			$description .= ' ' . __( 'You would have received an email because of this.' );180			$description .= ' ' . __( "When you've been able to update using the \"Update now\" button on Dashboard > Updates, this error will be cleared for future update attempts." );181			$description .= ' ' . sprintf(182				/* translators: %s: Code of error shown. */183				__( 'The error code was %s.' ),184				'<code>' . $failed['error_code'] . '</code>'185			);186			return array(187				'description' => $description,188				'severity'    => 'warning',189			);190		}191 192		$description = __( 'A previous automatic background update could not occur.' );193		if ( empty( $failed['retry'] ) ) {194			$description .= ' ' . __( 'You would have received an email because of this.' );195		}196 197		$description .= ' ' . __( 'Another attempt will be made with the next release.' );198		$description .= ' ' . sprintf(199			/* translators: %s: Code of error shown. */200			__( 'The error code was %s.' ),201			'<code>' . $failed['error_code'] . '</code>'202		);203		return array(204			'description' => $description,205			'severity'    => 'warning',206		);207	}

Changelog

Introduced in 5.2.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.0.4 tag, from src/wp-admin/includes/class-wp-site-health-auto-updates.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.