Function Reference/unzip file

This page redirects to an external site: https://developer.wordpress.org/reference/functions/unzip_file/

1 Description
2 Usage
3 Example
4 Parameters
5 Return Values
6 Change Log
7 Source File

Description

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.

Usage

<code style="color: #000000"><span style="color: #0000BB"><?php unzip_file</span><span style="color: #007700">( </span><span style="color: #0000BB">$file</span><span style="color: #007700">, </span><span style="color: #0000BB">$to </span><span style="color: #007700">); </span><span style="color: #0000BB">?></span></code>

Example

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

<code style="color: #000000"><span style="color: #0000BB"><?php
WP_Filesystem</span><span style="color: #007700">();
</span><span style="color: #0000BB">$destination </span><span style="color: #007700">= </span><span style="color: #0000BB">wp_upload_dir</span><span style="color: #007700">();
</span><span style="color: #0000BB">$destination_path </span><span style="color: #007700">= </span><span style="color: #0000BB">$destination</span><span style="color: #007700">[</span><span style="color: #DD0000">'path'</span><span style="color: #007700">];
</span><span style="color: #0000BB">$unzipfile </span><span style="color: #007700">= </span><span style="color: #0000BB">unzip_file</span><span style="color: #007700">( </span><span style="color: #0000BB">$destination_path</span><span style="color: #007700">.</span><span style="color: #DD0000">'/filename.zip'</span><span style="color: #007700">, </span><span style="color: #0000BB">$destination_path</span><span style="color: #007700">);
   
   if ( </span><span style="color: #0000BB">is_wp_error</span><span style="color: #007700">( </span><span style="color: #0000BB">$unzipfile </span><span style="color: #007700">) ) {
         echo </span><span style="color: #DD0000">'There was an error unzipping the file.'</span><span style="color: #007700">; 
   } else {
      echo </span><span style="color: #DD0000">'Successfully unzipped the file!'</span><span style="color: #007700">;       
   }
</span><span style="color: #0000BB">?></span></code>

Parameters

$file

(string) (required) Full path and filename of zip archive

Default: None

$to

(string) (required) Full path on the filesystem to extract archive to

Default: None

Return Values

(mixed): WP_Error on failure, True on success

Change Log

Since: 2.5

Source File

unzip_file() is located in wp-admin/includes/file.php

Codex