$files->copy() method

Copy all files recursively from one directory ($src) to another directory ($dst)

Unlike PHP's copy() function, this method performs a recursive copy by default, ensuring that all files and directories in the source ($src) directory are duplicated in the destination ($dst) directory.

This method can also be used to copy single files. If a file is specified for $src, and only a path is specified for $dst, then the original filename will be retained in $dst.

Example

// Copy everything from /site/assets/cache/foo/ to /site/assets/cache/bar/
$copyFrom = $config->paths->cache . "foo/";
$copyTo = $config->paths->cache . "bar/";
$files->copy($copyFrom, $copyTo); 

Usage

// basic usage
$bool = $files->copy(string $src, string $dst);

// usage with all arguments
$bool = $files->copy(string $src, string $dst, $options = []);

Arguments

NameType(s)Description
srcstring

Path to copy files from, or filename to copy.

dststring

Path (or filename) to copy file(s) to. Directory is created if it doesn't already exist.

options (optional)bool, array

Array of options:

  • recursive (boolean): Whether to copy directories within recursively. (default=true)
  • allowEmptyDirs (boolean): Copy directories even if they are empty? (default=true)
  • limitPath (bool|string|array): Limit copy to within path given here, or true for site assets path (default=false).
  • Note that the limitPath option was added in 3.0.118.
  • If a boolean is specified for $options, it is assumed to be the recursive option.

Return value

bool

True on success, false on failure.

Exceptions

Method can throw exceptions on error:

  • WireException - if limitPath option is used and either $src or $dst is not allowed


$files methods and properties

API reference based on ProcessWire core version 3.0.163

Twitter updates

  • This week ProcessWire version 3.0.166 is released on the dev branch. In this post we’ll cover all that’s new relative to the previous version, 3.0.165. Plus we’ll check out the latest new versions of ProCache and FormBuilder— More
    11 September 2020
  • Weekly update – 28 August 2020 – New secure files option defined per-template: More
    28 August 2020
  • ProcessWire 3.0.165 core updates (master and dev branch) and reCAPTCHA for FormBuilder module— More
    21 August 2020

Latest news

  • ProcessWire Weekly #331
    In the 331st issue of ProcessWire Weekly we're going to check out the latest core and Pro module updates (ProcessWire 3.0.166, ProCache 4.0.1, and Form Builder v44), introduce the Wireframe API module, and more. Read on!
    Weekly.pw / 12 September 2020
  • ProcessWire 3.0.166 core updates and more
    This week ProcessWire version 3.0.166 is released on the dev branch. In this post we’ll cover all that’s new relative to the previous version, 3.0.165. Plus we’ll check out the latest new versions of ProCache and FormBuilder.
    Blog / 11 September 2020
  • 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