WordPress at Your Fingertips
function is not described

Plugin_Upgrader::check_package() public WP 3.3.0

Checks that the source package contains a valid plugin.

Hooked to the upgrader_source_selection filter by Plugin_Upgrader::install().

{} It's a method of the class: Plugin_Upgrader{}

No Hooks.

Return

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

Usage

$Plugin_Upgrader = new Plugin_Upgrader();
$Plugin_Upgrader->check_package( $source );
$source(string) (required)
The path to the downloaded package source.

Notes

  • Global. WP_Filesystem_Base. $wp_filesystem WordPress filesystem subclass.
  • Global. String. $wp_version The WordPress version string.

Changelog

Since 3.3.0 Introduced.

Code of Plugin_Upgrader::check_package() WP 5.8.2

public function check_package( $source ) {
	global $wp_filesystem, $wp_version;

	$this->new_plugin_data = array();

	if ( is_wp_error( $source ) ) {
		return $source;
	}

	$working_directory = str_replace( $wp_filesystem->wp_content_dir(), trailingslashit( WP_CONTENT_DIR ), $source );
	if ( ! is_dir( $working_directory ) ) { // Sanity check, if the above fails, let's not prevent installation.
		return $source;
	}

	// Check that the folder contains at least 1 valid plugin.
	$files = glob( $working_directory . '*.php' );
	if ( $files ) {
		foreach ( $files as $file ) {
			$info = get_plugin_data( $file, false, false );
			if ( ! empty( $info['Name'] ) ) {
				$this->new_plugin_data = $info;
				break;
			}
		}
	}

	if ( empty( $this->new_plugin_data ) ) {
		return new WP_Error( 'incompatible_archive_no_plugins', $this->strings['incompatible_archive'], __( 'No valid plugins were found.' ) );
	}

	$requires_php = isset( $info['RequiresPHP'] ) ? $info['RequiresPHP'] : null;
	$requires_wp  = isset( $info['RequiresWP'] ) ? $info['RequiresWP'] : null;

	if ( ! is_php_version_compatible( $requires_php ) ) {
		$error = sprintf(
			/* translators: 1: Current PHP version, 2: Version required by the uploaded plugin. */
			__( 'The PHP version on your server is %1$s, however the uploaded plugin requires %2$s.' ),
			phpversion(),
			$requires_php
		);

		return new WP_Error( 'incompatible_php_required_version', $this->strings['incompatible_archive'], $error );
	}

	if ( ! is_wp_version_compatible( $requires_wp ) ) {
		$error = sprintf(
			/* translators: 1: Current WordPress version, 2: Version required by the uploaded plugin. */
			__( 'Your WordPress version is %1$s, however the uploaded plugin requires %2$s.' ),
			$wp_version,
			$requires_wp
		);

		return new WP_Error( 'incompatible_wp_required_version', $this->strings['incompatible_archive'], $error );
	}

	return $source;
}