Theme_Upgrader::bulk_upgrade( string[] $themes, array $args = array() ): 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.

Parameters

$themesstring[]

Array of the theme slugs.

$argsarrayoptional

Other arguments for upgrading several themes at once. Default empty array.Default: array()

• $clear_update_cachebooldefault: true

  Whether to clear the update cache if successful.

Return value

array[]|false

An array of results, or false if unable to connect to the filesystem.

Performance profile

How much work a call to Theme_Upgrader::bulk_upgrade() 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_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

62–210

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

Plugin surface

1 hook

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

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• transienttransientget_site_transient()called directly
• hookthird-party callbacksdo_action()called directly
• optionoption read or writeget_option()called directly
• cacheobject cachewp_cache_get()one call below Theme_Upgrader::bulk_upgrade()
• serializeserialisationmaybe_unserialize()one call below Theme_Upgrader::bulk_upgrade()

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

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

Hooks and filters fired · 1

One hook fires while Theme_Upgrader::bulk_upgrade() runs, in this order:

1. 1
   do_action( upgrader_process_complete )actionline 510 (+127 into the body)

   Fires when the upgrader process is complete.

Uses · 24

• wp_get_wp_version()Returns the current WordPress version.
• wp_parse_args()Merges user defined arguments into defaults array.
• get_site_transient()Retrieves the value of a site transient.
• add_filter()Adds a callback function to a filter hook.
• is_multisite()Determines whether Multisite is enabled.
• get_stylesheet()Retrieves name of the current stylesheet.
• get_template()Retrieves name of the active theme.
• is_wp_version_compatible()Checks compatibility with the current WordPress version.
• __()Retrieves the translation of $text.
• is_php_version_compatible()Checks compatibility with the current PHP version.
• get_theme_root()Retrieves path to themes directory.
• remove_filter()Removes a callback function from a filter hook.

Source code

View on Trac ↗View on GitHub ↗

383	public function bulk_upgrade( $themes, $args = array() ) {384		$wp_version  = wp_get_wp_version();385		$defaults    = array(386			'clear_update_cache' => true,387		);388		$parsed_args = wp_parse_args( $args, $defaults );389 390		$this->init();391		$this->bulk = true;392		$this->upgrade_strings();393 394		$current = get_site_transient( 'update_themes' );395 396		add_filter( 'upgrader_pre_install', array( $this, 'current_before' ), 10, 2 );397		add_filter( 'upgrader_post_install', array( $this, 'current_after' ), 10, 2 );398		add_filter( 'upgrader_clear_destination', array( $this, 'delete_old_theme' ), 10, 4 );399 400		$this->skin->header();401 402		// Connect to the filesystem first.403		$connected = $this->fs_connect( array( WP_CONTENT_DIR ) );404		if ( ! $connected ) {405			$this->skin->footer();406			return false;407		}408 409		$this->skin->bulk_header();410 411		/*412		 * Only start maintenance mode if:413		 * - running Multisite and there are one or more themes specified, OR414		 * - a theme with an update available is currently in use.415		 * @todo For multisite, maintenance mode should only kick in for individual sites if at all possible.416		 */417		$maintenance = ( is_multisite() && ! empty( $themes ) );418		foreach ( $themes as $theme ) {419			$maintenance = $maintenance || get_stylesheet() === $theme || get_template() === $theme;420		}421		if ( $maintenance ) {422			$this->maintenance_mode( true );423		}424 425		$results = array();426 427		$this->update_count   = count( $themes );428		$this->update_current = 0;429		foreach ( $themes as $theme ) {430			++$this->update_current;431 432			$this->skin->theme_info = $this->theme_info( $theme );433 434			if ( ! isset( $current->response[ $theme ] ) ) {435				$this->skin->set_result( true );436				$this->skin->before();437				$this->skin->feedback( 'up_to_date' );438				$this->skin->after();439				$results[ $theme ] = true;440				continue;441			}442 443			// Get the URL to the zip file.444			$upgrade_data = $current->response[ $theme ];445 446			if ( isset( $upgrade_data['requires'] ) && ! is_wp_version_compatible( $upgrade_data['requires'] ) ) {447				$result = new WP_Error(448					'incompatible_wp_required_version',449					sprintf(450						/* translators: 1: Current WordPress version, 2: WordPress version required by the new theme version. */451						__( 'Your WordPress version is %1$s, however the new theme version requires %2$s.' ),452						$wp_version,453						$upgrade_data['requires']454					)455				);456 457				$this->skin->before( $result );458				$this->skin->error( $result );459				$this->skin->after();460			} elseif ( isset( $upgrade_data['requires_php'] ) && ! is_php_version_compatible( $upgrade_data['requires_php'] ) ) {461				$result = new WP_Error(462					'incompatible_php_required_version',

Changelog

Introduced in 3.0.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-theme-upgrader.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.