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

Latest news

  • ProcessWire Weekly #489
    In the 489th issue of ProcessWire Weekly we'll check out what's new in the core this week, share a brand-new recipe of the week, and more. Read on!
    Weekly.pw / 23 September 2023
  • ProcessWire 3.0.226 new main/master version
    After 8 months in development we are excited to bring you ProcessWire 3.0.226 main/master. This version has a ton of great new features, improvements and optimizations, plus more than 100 issue fixes. This post takes an in-depth look at highlights from this great new version.
    Blog / 25 August 2023
  • 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