Rename by first copying files to destination and then deleting source files
The operation is considered successful so long as the source files were able to be copied to the destination. If source files cannot be deleted afterwards, the warning is logged, plus a warning notice is also shown when in debug mode.
Available since version 3.0.178.
Usage
// basic usage
$bool = $files->renameCopy(string $oldName, string $newName);
// usage with all arguments
$bool = $files->renameCopy(string $oldName, string $newName, array $options = []);Arguments
| Name | Type(s) | Description |
|---|---|---|
oldName | string | Old pathname, must be full disk path. |
newName | string | New pathname, must be full disk path OR can be basename to assume same path as $oldName. |
options (optional) | array | See options for rename() method |
Return value
bool
Exceptions
Method can throw exceptions on error:
WireException
API reference based on ProcessWire core version 3.0.228