get_core_updates( array $options = array() ): array<object>|false

Compatibility

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

Parameters

$optionsarrayoptional

Set $options['dismissed'] to true to show dismissed upgrades too, set $options['available'] to false to skip not-dismissed updates.Default: array()

Return value

array<object>|false

Array of the update objects on success, false on failure.

Performance profile

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

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

Scaling

Scales with input

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

Instructions

19–28

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

9

9 places 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
• transienttransientget_site_transient()called directly
• hookthird-party callbacksapply_filters()one call below get_core_updates()
• cacheobject cachewp_cache_get()one call below get_core_updates()

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

What one call costs · 1 distinct outcome

One number would be a lie: the work depends on which branch runs. These are every distinct cost get_core_updates() 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.
• get_site_transient()Retrieves the value of a site transient.

Used by · 9

• WP_Debug_Data::get_wp_core()Gets the WordPress core section of the debug data.
• WP_Site_Health::get_test_wordpress_version()Tests for WordPress version and outputs it.
• core_auto_updates_settings()Display WordPress auto-updates settings.
• core_upgrade_preamble()Display upgrade WordPress for downloading latest or upgrading automatically form.
• dismissed_updates()Display dismissed updates.
• get_preferred_from_update_core()Selects the first update version from the update_core option.
• list_core_update()Lists available core updates.
• list_plugin_updates()Display the upgrade plugins form.
• wp_get_update_data()Collects counts and UI strings for available updates.

Source code

View on Trac ↗View on GitHub ↗

39function get_core_updates( $options = array() ) {40	$options = array_merge(41		array(42			'available' => true,43			'dismissed' => false,44		),45		$options46	);47 48	$dismissed = get_site_option( 'dismissed_update_core' );49 50	if ( ! is_array( $dismissed ) ) {51		$dismissed = array();52	}53 54	$from_api = get_site_transient( 'update_core' );55 56	if ( ! isset( $from_api->updates ) || ! is_array( $from_api->updates ) ) {57		return false;58	}59 60	$updates = $from_api->updates;61	$result  = array();62 63	foreach ( $updates as $update ) {64		if ( 'autoupdate' === $update->response ) {65			continue;66		}67 68		if ( array_key_exists( $update->current . '|' . $update->locale, $dismissed ) ) {69			if ( $options['dismissed'] ) {70				$update->dismissed = true;71				$result[]          = $update;72			}73		} else {74			if ( $options['available'] ) {75				$update->dismissed = false;76				$result[]          = $update;77			}78		}79	}80 81	return $result;82}

Changelog

Introduced in 2.7.0. One change between 6.7.7 and 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-admin/includes/update.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.