WP_Automatic_Updater::should_update( string $type, object $item, string $context ): bool

Compatibility

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

Parameters

$typestring

The type of update being checked: 'core', 'theme', 'plugin', 'translation'.

$itemobject

The update offer.

$contextstring

The filesystem context (a path) against which filesystem access and status should be checked.

Return value

bool

True if the item should be updated, false otherwise.

Performance profile

How much work a call to WP_Automatic_Updater::should_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

Heavy

Reads or writes the filesystem via file_exists().

Scaling

Constant

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

Instructions

10–102

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

Plugin surface

1 hook

Third-party callbacks on 'auto_update_{$type}' run inside this call, and their cost is not bounded by anything here.

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
• hookthird-party callbacksapply_filters()called directly
• filesystemfilesystem accessfile_exists()called directly

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

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

Hooks and filters fired · 1

One hook fires while WP_Automatic_Updater::should_update() runs, in this order:

1. 1
   apply_filters( auto_update_{$type} )filterline 268 (+73 into the body)

   Filters whether to automatically update core, a plugin, a theme, or a language.

Uses · 8

• wp_is_auto_update_enabled_for_type()Checks whether auto-updates are enabled.
• get_site_option()Retrieve an option value for the current network based on name of option.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• Automatic_Upgrader_Skin::__construct()
• WP_Automatic_Updater::is_disabled()Determines whether the entire automatic updater is disabled.
• WP_Automatic_Updater::is_vcs_checkout()Checks for version control checkouts.
• WP_Automatic_Updater::send_core_update_notification_email()Notifies an administrator of a core update.
• Core_Upgrader::should_update_to_version()Determines if this WordPress Core version should update to an offered version or not.

Used by · 1

• WP_Automatic_Updater::update()Updates an item, if appropriate.

Source code

View on Trac ↗View on GitHub ↗

195	public function should_update( $type, $item, $context ) {196		// Used to see if WP_Filesystem is set up to allow unattended updates.197		$skin = new Automatic_Upgrader_Skin();198 199		if ( $this->is_disabled() ) {200			return false;201		}202 203		// Only relax the filesystem checks when the update doesn't include new files.204		$allow_relaxed_file_ownership = false;205		if ( 'core' === $type && isset( $item->new_files ) && ! $item->new_files ) {206			$allow_relaxed_file_ownership = true;207		}208 209		// If we can't do an auto core update, we may still be able to email the user.210		if ( ! $skin->request_filesystem_credentials( false, $context, $allow_relaxed_file_ownership )211			|| $this->is_vcs_checkout( $context )212		) {213			if ( 'core' === $type ) {214				$this->send_core_update_notification_email( $item );215			}216			return false;217		}218 219		// Next up, is this an item we can update?220		if ( 'core' === $type ) {221			$update = Core_Upgrader::should_update_to_version( $item->current );222		} elseif ( 'plugin' === $type || 'theme' === $type ) {223			$update = ! empty( $item->autoupdate );224 225			if ( ! $update && wp_is_auto_update_enabled_for_type( $type ) ) {226				// Check if the site admin has enabled auto-updates by default for the specific item.227				$auto_updates = (array) get_site_option( "auto_update_{$type}s", array() );228				$update       = in_array( $item->{$type}, $auto_updates, true );229			}230		} else {231			$update = ! empty( $item->autoupdate );232		}233 234		// If the `disable_autoupdate` flag is set, override any user-choice, but allow filters.235		if ( ! empty( $item->disable_autoupdate ) ) {236			$update = false;237		}238 239		/**240		 * Filters whether to automatically update core, a plugin, a theme, or a language.241		 *242		 * The dynamic portion of the hook name, `$type`, refers to the type of update243		 * being checked.244		 *245		 * Possible hook names include:246		 *247		 *  - `auto_update_core`248		 *  - `auto_update_plugin`249		 *  - `auto_update_theme`250		 *  - `auto_update_translation`251		 *252		 * Since WordPress 3.7, minor and development versions of core, and translations have253		 * been auto-updated by default. New installs on WordPress 5.6 or higher will also254		 * auto-update major versions by default. Starting in 5.6, older sites can opt-in to255		 * major version auto-updates, and auto-updates for plugins and themes.256		 *257		 * See the {@see 'allow_dev_auto_core_updates'}, {@see 'allow_minor_auto_core_updates'},258		 * and {@see 'allow_major_auto_core_updates'} filters for a more straightforward way to259		 * adjust core updates.260		 *261		 * @since 3.7.0262		 * @since 5.5.0 The `$update` parameter accepts the value of null.263		 *264		 * @param bool|null $update Whether to update. The value of null is internally used265		 *                          to detect whether nothing has hooked into this filter.266		 * @param object    $item   The update offer.267		 */268		$update = apply_filters( "auto_update_{$type}", $update, $item );269 270		if ( ! $update ) {271			if ( 'core' === $type ) {272				$this->send_core_update_notification_email( $item );273			}274			return false;

Changelog

Introduced in 3.7.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/class-wp-automatic-updater.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.