Home/ Manual/ zip / ziparchive/ ZipArchive::getCommentName

ZipArchive::getCommentName

PHP function Edit on GitHub ✎

(PHP 5 >= 5.2.0, PHP 7, PHP 8, PECL zip >= 1.4.0)

Returns the comment of an entry using the entry name

Description

ZipArchive::getCommentName(string $name, int $flags = 0): string|false

Returns the comment of an entry using the entry name.

Parameters

name: Name of the entry
flags: If flags is set to ZipArchive::FL_UNCHANGED, the original unchanged comment is returned.

Return Values

Returns the comment on successFalseforfailure.

Examples

Dump an entry comment

php

<?php
$zip = new ZipArchive;
$res = $zip->open('test1.zip');
if ($res === TRUE) {
    var_dump($zip->getCommentName('test/entry1.txt'));
} else {
    echo 'failed, code:' . $res;
}
?>

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