WordPress at Your Fingertips
function is not described

WP_Upgrader::unpack_package() public WP 2.8.0

Unpack a compressed package file.

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

No Hooks.

Return

String|WP_Error. The path to the unpacked contents, or a WP_Error on failure.

Usage

$WP_Upgrader = new WP_Upgrader();
$WP_Upgrader->unpack_package( $package, $delete_package );
$package(string) (required)
Full path to the package file.
$delete_package(true|false)
Whether to delete the package file after attempting to unpack it.
Default: true

Notes

  • Global. WP_Filesystem_Base. $wp_filesystem WordPress filesystem subclass.

Changelog

Since 2.8.0 Introduced.

Code of WP_Upgrader::unpack_package() WP 5.8.2

public function unpack_package( $package, $delete_package = true ) {
	global $wp_filesystem;

	$this->skin->feedback( 'unpack_package' );

	$upgrade_folder = $wp_filesystem->wp_content_dir() . 'upgrade/';

	// Clean up contents of upgrade directory beforehand.
	$upgrade_files = $wp_filesystem->dirlist( $upgrade_folder );
	if ( ! empty( $upgrade_files ) ) {
		foreach ( $upgrade_files as $file ) {
			$wp_filesystem->delete( $upgrade_folder . $file['name'], true );
		}
	}

	// We need a working directory - strip off any .tmp or .zip suffixes.
	$working_dir = $upgrade_folder . basename( basename( $package, '.tmp' ), '.zip' );

	// Clean up working directory.
	if ( $wp_filesystem->is_dir( $working_dir ) ) {
		$wp_filesystem->delete( $working_dir, true );
	}

	// Unzip package to working directory.
	$result = unzip_file( $package, $working_dir );

	// Once extracted, delete the package if required.
	if ( $delete_package ) {
		unlink( $package );
	}

	if ( is_wp_error( $result ) ) {
		$wp_filesystem->delete( $working_dir, true );
		if ( 'incompatible_archive' === $result->get_error_code() ) {
			return new WP_Error( 'incompatible_archive', $this->strings['incompatible_archive'], $result->get_error_data() );
		}
		return $result;
	}

	return $working_dir;
}