Plugin_Upgrader::check_package( string $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

The path to the downloaded package source.

Return value

string|WP_Error

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

Performance profile

How much work a call to Plugin_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

Heavy

Reads or writes the filesystem via is_dir().

Scaling

Scales with input

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

Instructions

12–78

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

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

• filesystemfilesystem accessis_dir()called directly
• hookthird-party callbacksdo_action()one call below Plugin_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 · 10 distinct outcomes

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

Uses · 8

• wp_get_wp_version()Returns the current WordPress version.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• trailingslashit()Appends a trailing slash.
• get_plugin_data()Parses the plugin contents to retrieve plugin's metadata.
• __()Retrieves the translation of $text.
• is_php_version_compatible()Checks compatibility with the current PHP version.
• is_wp_version_compatible()Checks compatibility with the current WordPress version.
• WP_Error::__construct()Initializes the error.

Source code

View on Trac ↗View on GitHub ↗

462	public function check_package( $source ) {463		global $wp_filesystem;464 465		$wp_version            = wp_get_wp_version();466		$this->new_plugin_data = array();467 468		if ( is_wp_error( $source ) ) {469			return $source;470		}471 472		$working_directory = str_replace( $wp_filesystem->wp_content_dir(), trailingslashit( WP_CONTENT_DIR ), $source );473		if ( ! is_dir( $working_directory ) ) { // Confidence check, if the above fails, let's not prevent installation.474			return $source;475		}476 477		// Check that the folder contains at least 1 valid plugin.478		$files = glob( $working_directory . '*.php' );479		if ( $files ) {480			foreach ( $files as $file ) {481				$new_plugin_data = get_plugin_data( $file, false, false );482				if ( ! empty( $new_plugin_data['Name'] ) ) {483					$this->new_plugin_data = $new_plugin_data;484					break;485				}486			}487		}488 489		if ( empty( $this->new_plugin_data ) ) {490			return new WP_Error( 'incompatible_archive_no_plugins', $this->strings['incompatible_archive'], __( 'No valid plugins were found.' ) );491		}492 493		$requires_php = $new_plugin_data['RequiresPHP'] ?? null;494		$requires_wp  = $new_plugin_data['RequiresWP'] ?? null;495 496		if ( ! is_php_version_compatible( $requires_php ) ) {497			$error = sprintf(498				/* translators: 1: Current PHP version, 2: Version required by the uploaded plugin. */499				__( 'The PHP version on your server is %1$s, however the uploaded plugin requires %2$s.' ),500				PHP_VERSION,501				$requires_php502			);503 504			return new WP_Error( 'incompatible_php_required_version', $this->strings['incompatible_archive'], $error );505		}506 507		if ( ! is_wp_version_compatible( $requires_wp ) ) {508			$error = sprintf(509				/* translators: 1: Current WordPress version, 2: Version required by the uploaded plugin. */510				__( 'Your WordPress version is %1$s, however the uploaded plugin requires %2$s.' ),511				$wp_version,512				$requires_wp513			);514 515			return new WP_Error( 'incompatible_wp_required_version', $this->strings['incompatible_archive'], $error );516		}517 518		return $source;519	}

Changelog

Introduced in 3.3.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-plugin-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.