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

ZipArchive::setPassword

PHP function Edit on GitHub ✎

(PHP 5 >= 5.6.0, PHP 7, PHP 8, PECL zip >= 1.12.4)

Set the password for the active archive

Description

ZipArchive::setPassword(string $password): bool

Sets the password for the active archive.

Parameters

password

The password to be used for the archive.

Return Values

Success

Notes

Note

As of PHP 7.2.0 and libzip 1.2.0 the password is used to decompress the archive, and is also the default password for ZipArchive::setEncryptionName and ZipArchive::setEncryptionIndex. Formerly, this function only set the password to be used to decompress the archive; it did not turn a non-password-protected ZipArchive into a password-protected ZipArchive.

See Also

  • ZipArchive::setEncryptionIndex
  • ZipArchive::setEncryptionName

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