ZipArchive::renameIndex

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

    ZipArchive::renameIndex — Renames an entry defined by its index

    Description

    public ZipArchive::renameIndex(int $index, string $new_name): bool

    Renames an entry defined by its index.

    Parameters

    index

    Index of the entry to rename.

    new_name

    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->renameIndex(2,'newname.txt');
    $zip->close();
    } else {
    echo     'failed, code:' . $res;
    }
    ?>

    Found A Problem?

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes 2 notes

    up
    1
    Jonathan Holvey
    8 years ago
    To rename a folder, you must replace the folder name in the path of every file that it contains.
    up
    0
    troy_rudolph at bridge360 dot com
    8 years ago
    I have tried to rename folders inside the zip file using ZipArchive::renameIndex() and ZipArchive::renameName(). Neither was successful. I believe that this is not a bug and wanted to document it.
    ＋add a note
    To Top