WP_Automatic_Updater::is_disabled(): bool

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

bool

True if the automatic updater is disabled, false otherwise.

Performance profile

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

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

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

Instructions

5–17

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

Plugin surface

1 hook

Third-party callbacks on 'automatic_updater_disabled' run inside this call, and their cost is not bounded by anything here.

Called by

2

2 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly

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_Automatic_Updater::is_disabled() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

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

1. 1
   apply_filters( automatic_updater_disabled )filterline 58 (+25 into the body)

   Filters whether to entirely disable background updates.

Uses · 3

• wp_is_file_mod_allowed()Determines whether file modifications are allowed.
• wp_installing()Checks or sets whether WordPress is in "installation" mode.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 2

• WP_Automatic_Updater::run()Kicks off the background update process, looping through all pending updates.
• WP_Automatic_Updater::should_update()Tests to see if we can and should update a specific item.

Source code

View on Trac ↗View on GitHub ↗

33	public function is_disabled() {34		// Background updates are disabled if you don't want file changes.35		if ( ! wp_is_file_mod_allowed( 'automatic_updater' ) ) {36			return true;37		}38 39		if ( wp_installing() ) {40			return true;41		}42 43		// More fine grained control can be done through the WP_AUTO_UPDATE_CORE constant and filters.44		$disabled = defined( 'AUTOMATIC_UPDATER_DISABLED' ) && AUTOMATIC_UPDATER_DISABLED;45 46		/**47		 * Filters whether to entirely disable background updates.48		 *49		 * There are more fine-grained filters and controls for selective disabling.50		 * This filter parallels the AUTOMATIC_UPDATER_DISABLED constant in name.51		 *52		 * This also disables update notification emails. That may change in the future.53		 *54		 * @since 3.7.055		 *56		 * @param bool $disabled Whether the updater should be disabled.57		 */58		return apply_filters( 'automatic_updater_disabled', $disabled );59	}

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.