Language_Pack_Upgrader::bulk_upgrade( object[] $language_updates = array(), array $args = array() ): array|bool|WP_Error

Compatibility

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

Parameters

$language_updatesobject[]optional

Array of language packs to update. See wp_get_translation_updates().
Default empty array.Default: array()

$argsarrayoptional

Other arguments for upgrading multiple language packs. Default empty array.Default: array()

• $clear_update_cachebooldefault: true

  Whether to clear the update cache when done.

Return value

array|bool|WP_Error

Will return an array of results, or true if there are no updates, false or WP_Error for initial errors.

Performance profile

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

34–187

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

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

1

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

What it touches

• hookthird-party callbacksdo_action()called directly
• transienttransientget_site_transient()one call below Language_Pack_Upgrader::bulk_upgrade()

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

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

Hooks and filters fired · 1

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

1. 1
   do_action( upgrader_process_complete )actionline 280 (+113 into the body)

   Fires when the upgrader process is complete.

Uses · 15

• wp_parse_args()Merges user defined arguments into defaults array.
• wp_get_translation_updates()Retrieves a list of all language updates available.
• current_filter()Retrieves the name of the current filter hook.
• remove_all_filters()Removes all of the callback functions from a filter hook.
• add_filter()Adds a callback function to a filter hook.
• remove_action()Removes a callback function from an action hook.
• do_action()Calls the callback functions that have been added to an action hook.
• add_action()Adds a callback function to an action hook.
• remove_filter()Removes a callback function from a filter hook.
• wp_clean_update_cache()Clears existing update caches for plugins, themes, and core.
• Language_Pack_Upgrader::init()
• Language_Pack_Upgrader::upgrade_strings()Initializes the upgrade strings.

Used by · 1

• Language_Pack_Upgrader::upgrade()Upgrades a language pack.

Source code

View on Trac ↗View on GitHub ↗

167	public function bulk_upgrade( $language_updates = array(), $args = array() ) {168		global $wp_filesystem;169 170		$defaults    = array(171			'clear_update_cache' => true,172		);173		$parsed_args = wp_parse_args( $args, $defaults );174 175		$this->init();176		$this->upgrade_strings();177 178		if ( ! $language_updates ) {179			$language_updates = wp_get_translation_updates();180		}181 182		if ( empty( $language_updates ) ) {183			$this->skin->header();184			$this->skin->set_result( true );185			$this->skin->feedback( 'up_to_date' );186			$this->skin->bulk_footer();187			$this->skin->footer();188			return true;189		}190 191		if ( 'upgrader_process_complete' === current_filter() ) {192			$this->skin->feedback( 'starting_upgrade' );193		}194 195		// Remove any existing upgrade filters from the plugin/theme upgraders #WP29425 & #WP29230.196		remove_all_filters( 'upgrader_pre_install' );197		remove_all_filters( 'upgrader_clear_destination' );198		remove_all_filters( 'upgrader_post_install' );199		remove_all_filters( 'upgrader_source_selection' );200 201		add_filter( 'upgrader_source_selection', array( $this, 'check_package' ), 10, 2 );202 203		$this->skin->header();204 205		// Connect to the filesystem first.206		$res = $this->fs_connect( array( WP_CONTENT_DIR, WP_LANG_DIR ) );207		if ( ! $res ) {208			$this->skin->footer();209			return false;210		}211 212		$results = array();213 214		$this->update_count   = count( $language_updates );215		$this->update_current = 0;216 217		/*218		 * The filesystem's mkdir() is not recursive. Make sure WP_LANG_DIR exists,219		 * as we then may need to create a /plugins or /themes directory inside of it.220		 */221		$remote_destination = $wp_filesystem->find_folder( WP_LANG_DIR );222		if ( ! $wp_filesystem->exists( $remote_destination ) ) {223			if ( ! $wp_filesystem->mkdir( $remote_destination, FS_CHMOD_DIR ) ) {224				return new WP_Error( 'mkdir_failed_lang_dir', $this->strings['mkdir_failed'], $remote_destination );225			}226		}227 228		$language_updates_results = array();229 230		foreach ( $language_updates as $language_update ) {231 232			$this->skin->language_update = $language_update;233 234			$destination = WP_LANG_DIR;235			if ( 'plugin' === $language_update->type ) {236				$destination .= '/plugins';237			} elseif ( 'theme' === $language_update->type ) {238				$destination .= '/themes';239			}240 241			++$this->update_current;242 243			$options = array(244				'package'                     => $language_update->package,245				'destination'                 => $destination,246				'clear_destination'           => true,

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 7.0.4 tag, from src/wp-admin/includes/class-language-pack-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.