php8.5
Home/ Manual/ zip / ziparchive/ ZipArchive::extractTo

ZipArchive::extractTo

PHP function Edit on GitHub ✎

(PHP 5 >= 5.2.0, PHP 7, PHP 8, PECL zip >= 1.1.0)

Extract the archive contents

Description

ZipArchive::extractTo(string $pathto, array|string|null $files = null): bool

Extract the complete archive or the given files to the specified destination.

Warning

The default permissions for extracted files and directories give the widest possible access. This can be restricted by setting the current umask, which can be changed using umask().

For security reasons, the original permissions are not restored. For an example of how to restore them, see the code sample on the ZipArchive::getExternalAttributesIndex page.

Parameters

pathto

Location where to extract the files.

files

The entries to extract. It accepts either a single entry name or an array of names.

Return Values

Success

Examples

Extract all entries

php
<?php
$zip = new ZipArchive;
if ($zip->open('test.zip') === TRUE) {
    $zip->extractTo('/my/destination/dir/');
    $zip->close();
    echo 'ok';
} else {
    echo 'failed';
}
?>

Extract two entries

php
<?php
$zip = new ZipArchive;
$res = $zip->open('test_im.zip');
if ($res === TRUE) {
    $zip->extractTo('/my/destination/dir/', array('pear_item.gif', 'testfromfile.php'));
    $zip->close();
    echo 'ok';
} else {
    echo 'failed';
}
?>

Notes Extractto-windows

Source: reference/zip/ziparchive/extractto.xml · from the official PHP manual (php/doc-en)