php8.5
Home/ Manual/ eio / functions/ eio_rename

eio_rename

PHP function Edit on GitHub ✎

(PECL eio >= 0.0.1dev)

Change the name or location of a file

Description

eio_rename(string $path, string $new_path, int $pri = EIO_PRI_DEFAULT, callable $callback = NULL, mixed $data = NULL): resource

eio_rename() renames or moves a file to new location.

Parameters

path

Source path

new_path

Target path

pri

Values

callback

Proto

data

Arbitrary variable passed to callback.

Return Values

eio_rename() returns request resource on success,Falseforfailure.

Examples

eio_rename() example

php
<?php
$filename = dirname(__FILE__)."/eio-temp-file.dat";
touch($filename);
$new_filename = dirname(__FILE__)."/eio-temp-file-new.dat";

function my_rename_cb($data, $result) {
    global $filename, $new_filename;

    if ($result == 0 && !file_exists($filename) && file_exists($new_filename)) {
        @unlink($new_filename);
        echo "eio_rename_ok";
    } else {
        @unlink($filename);
    }
}

eio_rename($filename, $new_filename, EIO_PRI_DEFAULT, "my_rename_cb", $filename);
eio_event_loop();
?>

The above example will output something similar to:

output
eio_rename_ok

Source: reference/eio/functions/eio-rename.xml · from the official PHP manual (php/doc-en)