wireUnzipFile() function

Unzips the given ZIP file to the destination directory

This is procedural version of the $files->unzip() method. See that method for more details.

Please note this method is and thus not intended to be called directly.

Internal usage

$array = wireUnzipFile(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


Functions methods and properties

API reference based on ProcessWire core version 3.0.251