WordPress at a glance

unzip_file() WP 1.0

Unzips a specified ZIP file to a location on the Filesystem via the WordPress Filesystem Abstraction. 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.

  • Global. WP_Filesystem_Base. $wp_filesystem Subclass
Works based on: _unzip_file_pclzip()
Hooks in function

Mixed. WP_Error on failure, True on success


unzip_file( $file, $to );
$file(string) (required)
Full path and filename of zip archive
$to(string) (required)
Full path on the filesystem to extract archive to

Code of unzip file: wp-admin/includes/file.php VER 5.0.3

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]) )

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

			if ( ! $wp_filesystem->is_dir($dir) )
				$needed_dirs[] = $dir;
				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);

Related Functions

From tag: File system (create delete files folders)

No comments
    Hello, !     Log In . Register