WordPress Hooks Explorer 🪝

Filter hook 'pre_unzip_file'

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

Description

Filters archive unzipping to override with a custom process.

Occurrences

Filename Line Number
wp-admin/includes/file.php 1798
wp-admin/includes/file.php 1969

Parameters

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

PHP Doc

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