HomeMenu
Jesus · Bible · HTML · CSS · JS · PHP · SVG · Applications

rename

Description

The rename of Filesystem for PHP renames a file or directory.

Syntax

rename(
    string $from,
    string $to,
    ?resource $context = null
): bool

Parameters

from

The old name.

NOTE: The wrapper used in from must match the wrapper used in to.

to

The new name.

NOTE: On Windows, if to already exists, it must be writable. Otherwise rename() fails and issues E_WARNING.

context

A context stream resource.

Return

Returns true on success or false on failure.

Examples

1 · from to

<?

$from = $_SERVER['DOCUMENT_ROOT'] . '/assets/txt/from.txt';
$to = $_SERVER['DOCUMENT_ROOT'] . '/assets/txt/to.txt';

$return = rename($from, $to);

var_export($return);

true

2 · context

<?

$from = $_SERVER['DOCUMENT_ROOT'] . '/assets/txt/from.txt';
$to = $_SERVER['DOCUMENT_ROOT'] . '/assets/txt/to.txt';
$context = stream_context_create();

$return = rename($from, $to, $context);

var_export($return);

true