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

ZipArchive::setCommentName

PHP function Edit on GitHub ✎

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

Set the comment of an entry defined by its name

Description

ZipArchive::setCommentName(string $name, string $comment): bool

Set the comment of an entry defined by its name.

Parameters

name

Name of the entry.

comment

The contents of the comment.

Return Values

Success

Examples

Open an archive and set a comment for an entry

php
<?php
$zip = new ZipArchive;
$res = $zip->open('test.zip');
if ($res === TRUE) {
    $zip->setCommentName('entry1.txt', 'new entry comment');
    $zip->close();
    echo 'ok';
} else {
    echo 'failed';
}
?>

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