Language_Pack_Upgrader::async_upgrade( false|WP_Upgrader $upgrader = false )

Description

Compatibility

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

Parameters

$upgraderfalse|WP_Upgraderoptional

WP_Upgrader instance or false. If $upgrader is a Language_Pack_Upgrader instance, the method will bail to avoid recursion. Otherwise unused. Default false.Default: false

Performance profile

How much work a call to Language_Pack_Upgrader::async_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

5–37

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

Plugin surface

1 hook

Third-party callbacks on 'async_update_translation' 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

• hookthird-party callbacksapply_filters()called directly
• transienttransientget_site_transient()one call below Language_Pack_Upgrader::async_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 · 4 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost Language_Pack_Upgrader::async_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::async_upgrade() runs, in this order:

1. 1
   apply_filters( async_update_translation )filterline 81 (+32 into the body)

   Filters whether to asynchronously update translation for core, a plugin, or a theme.

Uses · 5

• wp_get_translation_updates()Retrieves a list of all language updates available.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• WP_Automatic_Updater::__construct()
• Language_Pack_Upgrader_Skin::__construct()Constructor.
• Language_Pack_Upgrader::__construct()

Source code

View on Trac ↗View on GitHub ↗

49	public static function async_upgrade( $upgrader = false ) {50		// Avoid recursion.51		if ( $upgrader && $upgrader instanceof Language_Pack_Upgrader ) {52			return;53		}54 55		// Nothing to do?56		$language_updates = wp_get_translation_updates();57		if ( ! $language_updates ) {58			return;59		}60 61		/*62		 * Avoid messing with VCS installations, at least for now.63		 * Noted: this is not the ideal way to accomplish this.64		 */65		$check_vcs = new WP_Automatic_Updater();66		if ( $check_vcs->is_vcs_checkout( WP_CONTENT_DIR ) ) {67			return;68		}69 70		foreach ( $language_updates as $key => $language_update ) {71			$update = ! empty( $language_update->autoupdate );72 73			/**74			 * Filters whether to asynchronously update translation for core, a plugin, or a theme.75			 *76			 * @since 4.0.077			 *78			 * @param bool   $update          Whether to update.79			 * @param object $language_update The update offer.80			 */81			$update = apply_filters( 'async_update_translation', $update, $language_update );82 83			if ( ! $update ) {84				unset( $language_updates[ $key ] );85			}86		}87 88		if ( empty( $language_updates ) ) {89			return;90		}91 92		// Re-use the automatic upgrader skin if the parent upgrader is using it.93		if ( $upgrader && $upgrader->skin instanceof Automatic_Upgrader_Skin ) {94			$skin = $upgrader->skin;95		} else {96			$skin = new Language_Pack_Upgrader_Skin(97				array(98					'skip_header_footer' => true,99				)100			);101		}102 103		$lp_upgrader = new Language_Pack_Upgrader( $skin );104		$lp_upgrader->bulk_upgrade( $language_updates );105	}

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.