ZipArchive::renameName

(PHP 5 >= 5.2.0, PHP 7, PECL zip >= 1.5.0)

ZipArchive::renameNameRenames an entry defined by its name

Description

ZipArchive::renameName ( string $name , string $newname ) : bool

Renames an entry defined by its name.

Parameters

name

Name of the entry to rename.

newname

New name.

Return Values

Returns TRUE on success or FALSE on failure.

Examples

Example #1 Rename one entry

<?php
$zip 
= new ZipArchive;
$res $zip->open('test.zip');
if (
$res === TRUE) {
    
$zip->renameName('currentname.txt','newname.txt');
    
$zip->close();
} else {
    echo 
'failed, code:' $res;
}
?>
add a note add a note

User Contributed Notes 1 note

up
3
mumpitz89 at gmx dot net
3 years ago
When you rename a file in an archive using the function above and the target file name already exists, the function will return FALSE as a result.
To Top