$files->unzip() method

Unzips the given ZIP file to the destination directory

Example

// Unzip a file 
$zip = $config->paths->cache . "my-file.zip";
$dst = $config->paths->cache . "my-files/";
$items = $files->unzip($zip, $dst);
if(count($items)) {
  // $items is an array of filenames that were unzipped into $dst
}

Usage

$array = $files->unzip(string $file, string $dst);

Arguments

NameType(s)Description
filestring

ZIP file to extract

dststring

Directory where files should be unzipped into. Directory is created if it doesn't exist.

Return value

array

Returns an array of filenames (excluding $dst) that were unzipped.

Exceptions

Method can throw exceptions on error:

  • WireException - All error conditions result in WireException being thrown.

See Also


$files methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #538
    In the 538th issue of ProcessWire Weekly we’re going to share the latest news from the ProcessWire community; modules, sites, and more. Read on!
    Weekly.pw / 31 August 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

“ProcessWire is like a breath of fresh air. So powerful yet simple to build with and customise, and web editors love it too.” —Margaret Chatwin, Web developer