Language_Pack_Upgrader::check_package( string|WP_Error $source, string $remote_source ): string|WP_Error

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

$sourcestring|WP_Error

The path to the downloaded package source.

$remote_sourcestring

Remote file source location.

Return value

string|WP_Error

The source as passed, or a WP_Error object on failure.

Performance profile

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

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

8–39

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

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

What it touches

• hookthird-party callbacksdo_action()one call below Language_Pack_Upgrader::check_package()

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

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

Uses · 4

• is_wp_error()Checks whether the given variable is a WordPress Error.
• str_ends_with()Polyfill for `str_ends_with()` function added in PHP 8.0.
• __()Retrieves the translation of $text.
• WP_Error::__construct()Initializes the error.

Source code

View on Trac ↗View on GitHub ↗

325	public function check_package( $source, $remote_source ) {326		global $wp_filesystem;327 328		if ( is_wp_error( $source ) ) {329			return $source;330		}331 332		// Check that the folder contains a valid language.333		$files = $wp_filesystem->dirlist( $remote_source );334 335		// Check to see if the expected files exist in the folder.336		$po  = false;337		$mo  = false;338		$php = false;339		foreach ( (array) $files as $file => $filedata ) {340			if ( str_ends_with( $file, '.po' ) ) {341				$po = true;342			} elseif ( str_ends_with( $file, '.mo' ) ) {343				$mo = true;344			} elseif ( str_ends_with( $file, '.l10n.php' ) ) {345				$php = true;346			}347		}348 349		if ( $php ) {350			return $source;351		}352 353		if ( ! $mo || ! $po ) {354			return new WP_Error(355				'incompatible_archive_pomo',356				$this->strings['incompatible_archive'],357				sprintf(358					/* translators: 1: .po, 2: .mo, 3: .l10n.php */359					__( 'The language pack is missing either the %1$s, %2$s, or %3$s files.' ),360					'<code>.po</code>',361					'<code>.mo</code>',362					'<code>.l10n.php</code>'363				)364			);365		}366 367		return $source;368	}

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-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.