unzip_file – Hook | Developer.WordPress.org

apply_filters( ‘unzip_file’, true|WP_Error $result, string $file, string $to, string[] $needed_dirs, float $required_space )

Filters the result of unzipping an archive.

Parameters

$resulttrue|WP_Error: The result of unzipping the archive. True on success, otherwise WP_Error. Default true.
$filestring: Full path and filename of ZIP archive.
$tostring: Full path on the filesystem the archive was extracted to.
$needed_dirsstring[]: A full list of required folders that were created.
$required_spacefloat: The space required to unzip the file and copy its contents, with a 10% buffer.

$result = apply_filters( 'unzip_file', true, $file, $to, $needed_dirs, $required_space );

Used by	Description
_unzip_file_ziparchive()`wp-admin/includes/file.php`	Attempts to unzip an archive using the ZipArchive class.
_unzip_file_pclzip()`wp-admin/includes/file.php`	Attempts to unzip an archive using the PclZip library.

Version	Description
6.4.0	Introduced.

You must log in before being able to contribute a note or feedback.