Please wait while we load your page...


PHP Manual [ZipArchive

Protect Your Website Today

PHP Manual || ZipArchive

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

ZipArchive::addFileAdds a file to a ZIP archive from the given path


public ZipArchive::addFile ( string $filename [, string $localname = NULL [, int $start = 0 [, int $length = 0 [, int $flags = ZipArchive::FL_OVERWRITE ]]]] ) : bool

Adds a file to a ZIP archive from a given path.

Note: For maximum portability, it is recommended to always use forward slashes (/) as directory separator in ZIP filenames.



The path to the file to add.


If supplied, this is the local name inside the ZIP archive that will override the filename.


For partial copy, start position.


For partial copy, length to be copied, if 0 or -1 the whole file (starting from start) is used.


Bitmask consisting of ZipArchive::FL_OVERWRITE, ZipArchive::FL_ENC_GUESS, ZipArchive::FL_ENC_UTF_8, ZipArchive::FL_ENC_CP437. The behaviour of these constants is described on the ZIP constants page.

Return Values

Returns TRUE on success or FALSE on failure.


Version Description
8.0.0 / 1.18.0 flags was added.


This example opens a ZIP file archive and add the file /path/to/index.txt. as newname.txt.

Example #1 Open and add

= new ZipArchive;
if (
$zip->open('') === TRUE) {
} else {



When a file is set to be added to the archive, PHP will lock the file. The lock is only released once the ZipArchive object has been closed, either via ZipArchive::close() or the ZipArchive object being destroyed. This may prevent you from being able to delete the file being added until after the lock has been released.

See Also

PHP Manual || ZipArchive