$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.248

Latest news

  • ProcessWire Weekly #574
    The 574th issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 10 May 2025
  • New ProcessWire admin redesign
    When you upgrade to ProcessWire 3.0.248 or newer (currently the dev branch), you’ll immediately notice something new and beautiful…
    Blog / 9 May 2025
  • Subscribe to weekly ProcessWire news

“I am currently managing a ProcessWire site with 2 million+ pages. It’s admirably fast, and much, much faster than any other CMS we tested.” —Nickie, Web developer