ZipArchive::getArchiveComment
PHP function
Edit on GitHub ✎
(PHP 5 >= 5.2.0, PHP 7, PHP 8, PECL zip >= 1.1.0)
Returns the Zip archive comment
Description
ZipArchive::getArchiveComment(int $flags = 0): string|false
Returns the Zip archive comment.
Parameters
flagsIf flags is set to
ZipArchive::FL_UNCHANGED, the original unchanged comment is returned.
Return Values
Returns the Zip archive commentFalseforfailure.
Examples
Dump an archive comment
php
<?php
$zip = new ZipArchive;
$res = $zip->open('test_with_comment.zip');
if ($res === TRUE) {
var_dump($zip->getArchiveComment());
/* Or using the archive property */
var_dump($zip->comment);
} else {
echo 'failed, code:' . $res;
}
?>