ConFoo 2025

ZipArchive::setCommentName

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

ZipArchive::setCommentNameSet the comment of an entry defined by its name

Description

public 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

Returns true on success or false on failure.

Examples

Example #1 Open an archive and set a comment for an entry

<?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';
}
?>
add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top