unzip_file( string $file, string $to )

Unzips a specified ZIP file to a location on the filesystem via the WordPress Filesystem Abstraction.

Contents

Description Description

Assumes that WP_Filesystem() has already been called and set up. Does not extract a root-level __MACOSX directory, if present.

Attempts to increase the PHP memory limit to 256M before uncompressing. However, the most memory required shouldn’t be much larger than the archive itself.

Parameters Parameters

$file

(string) (Required) Full path and filename of ZIP archive.

$to

(string) (Required) Full path on the filesystem to extract archive to.

Top ↑

Return Return

(true|WP_Error) True on success, WP_Error on failure.

Top ↑

Source Source

File: wp-admin/includes/file.php 

function unzip_file( $file, $to ) {
	global $wp_filesystem;

	if ( ! $wp_filesystem || ! is_object( $wp_filesystem ) ) {
		return new WP_Error( 'fs_unavailable', __( 'Could not access filesystem.' ) );
	}

	// Unzip can use a lot of memory, but not this much hopefully.
	wp_raise_memory_limit( 'admin' );

	$needed_dirs = array();
	$to          = trailingslashit( $to );

	// Determine any parent dir's needed (of the upgrade directory)
	if ( ! $wp_filesystem->is_dir( $to ) ) { //Only do parents if no children exist
		$path = preg_split( '![/\\\]!', untrailingslashit( $to ) );
		for ( $i = count( $path ); $i >= 0; $i-- ) {
			if ( empty( $path[ $i ] ) ) {
				continue;
			}

			$dir = implode( '/', array_slice( $path, 0, $i + 1 ) );
			if ( preg_match( '!^[a-z]:$!i', $dir ) ) { // Skip it if it looks like a Windows Drive letter.
				continue;
			}

			if ( ! $wp_filesystem->is_dir( $dir ) ) {
				$needed_dirs[] = $dir;
			} else {
				break; // A folder exists, therefor, we dont need the check the levels below this
			}
		}
	}

	/**
	 * Filters whether to use ZipArchive to unzip archives.
	 *
	 * @since 3.0.0
	 *
	 * @param bool $ziparchive Whether to use ZipArchive. Default true.
	 */
	if ( class_exists( 'ZipArchive', false ) && apply_filters( 'unzip_file_use_ziparchive', true ) ) {
		$result = _unzip_file_ziparchive( $file, $to, $needed_dirs );
		if ( true === $result ) {
			return $result;
		} elseif ( is_wp_error( $result ) ) {
			if ( 'incompatible_archive' != $result->get_error_code() ) {
				return $result;
			}
		}
	}
	// Fall through to PclZip if ZipArchive is not available, or encountered an error opening the file.
	return _unzip_file_pclzip( $file, $to, $needed_dirs );
}

Expand full source code Collapse full source code View on Trac

Top ↑

Changelog Changelog

Changelog
Version Description
2.5.0 Introduced.

Top ↑

Top ↑

Uses Uses

Uses
Uses Description
wp-includes/functions.php: wp_raise_memory_limit()

Attempts to raise the PHP memory limit for memory intensive processes.
wp-admin/includes/file.php: _unzip_file_ziparchive()

Attempts to unzip an archive using the ZipArchive class.
wp-admin/includes/file.php: _unzip_file_pclzip()

Attempts to unzip an archive using the PclZip library.
wp-admin/includes/file.php: unzip_file_use_ziparchive

Filters whether to use ZipArchive to unzip archives.
wp-includes/l10n.php: __()

Retrieve the translation of $text.
wp-includes/formatting.php: trailingslashit()

Appends a trailing slash.
wp-includes/formatting.php: untrailingslashit()

Removes trailing forward slashes and backslashes if they exist.
wp-includes/plugin.php: apply_filters()

Call the functions added to a filter hook.
wp-includes/load.php: is_wp_error()

Check whether variable is a WordPress Error.
wp-includes/class-wp-error.php: WP_Error::__construct()

Initialize the error.
Show 5 more uses Hide more uses

Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    Example

    Basic example showing how to unzip the contents of a .zip file, that resides in the WordPress upload directory, to the same destination.

    <?php
WP_Filesystem();
$destination = wp_upload_dir();
$destination_path = $destination['path'];
$unzipfile = unzip_file( $destination_path.'/filename.zip', $destination_path);
   
   if ( $unzipfile ) {
      echo 'Successfully unzipped the file!';       
   } else {
      echo 'There was an error unzipping the file.';       
   }
?>

You must log in before being able to contribute a note or feedback.