WordPress Hooks Explorer 🪝

Filter hook 'unzip_file'

in WP Core File wp-admin/includes/file.php at line 1854

Description

Filters the result of unzipping an archive.

Occurrences

Filename Line Number
wp-admin/includes/file.php 1854
wp-admin/includes/file.php 1996

Parameters

Type Name Description
true|WP_Error $result The result of unzipping the archive. True on success, otherwise WP_Error. Default true.
string $file Full path and filename of ZIP archive.
string $to Full path on the filesystem the archive was extracted to.
string[] $needed_dirs A full list of required folders that were created.
float $required_space The space required to unzip the file and copy its contents, with a 10% buffer.

PHP Doc

/**
	 * Filters the result of unzipping an archive.
	 *
	 * @since 6.4.0
	 *
	 * @param true|WP_Error $result         The result of unzipping the archive. True on success, otherwise WP_Error. Default true.
	 * @param string        $file           Full path and filename of ZIP archive.
	 * @param string        $to             Full path on the filesystem the archive was extracted to.
	 * @param string[]      $needed_dirs    A full list of required folders that were created.
	 * @param float         $required_space The space required to unzip the file and copy its contents, with a 10% buffer.
	 */