$files->renameCopy() method

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

NameType(s)Description
oldNamestring

Old pathname, must be full disk path.

newNamestring

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


$files methods and properties

API reference based on ProcessWire core version 3.0.185

Twitter updates

  • ProcessWire 3.0.185 (dev) core updates, plus new Session Allow module— More
    17 September 2021
  • Three new ProcessWire Textformatter modules: Find/Replace, Markdown in Markup, and Emoji— More
    3 September 2021
  • This week we have a new master version released after a year in the making. With nearly 40 pull requests, hundreds of new additions and more than 100 issue reports resolved, this new version has a ton of great new stuff— More
    27 August 2021

Latest news

  • ProcessWire Weekly #388
    In the 388th issue of ProcessWire Weekly we'll check out the latest core update, introduce two new third party modules, and more. Read on!
    Weekly.pw / 16 October 2021
  • ProcessWire 3.0.184 new master/main version
    This week we have a new master/main version released after a full year in the making. As you might imagine, this new version has a ton of great new stuff and we’ll try to cover much of it here.
    Blog / 27 August 2021
  • Subscribe to weekly ProcessWire news

“…building with ProcessWire was a breeze, I really love all the flexibility the system provides. I can’t imagine using any other CMS in the future.” —Thomas Aull