WP_Filesystem_Direct::copy() WordPress Method
The WP_Filesystem_Direct::copy() is a method used to recursively copy a directory from one location to another. This is a static method and does not require an instantiated object.
WP_Filesystem_Direct::copy( string $source, string $destination, bool $overwrite = false, int|false $mode = false ) #
Copies a file.
Parameters
- $source
(string)(Required)Path to the source file.
- $destination
(string)(Required)Path to the destination file.
- $overwrite
(bool)(Optional) Whether to overwrite the destination file if it exists.
Default value: false
- $mode
(int|false)(Optional) The permissions as octal number, usually 0644 for files, 0755 for dirs.
Default value: false
Return
(bool) True on success, false on failure.
Source
File: wp-admin/includes/class-wp-filesystem-direct.php
public function copy( $source, $destination, $overwrite = false, $mode = false ) {
if ( ! $overwrite && $this->exists( $destination ) ) {
return false;
}
$rtval = copy( $source, $destination );
if ( $mode ) {
$this->chmod( $destination, $mode );
}
return $rtval;
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 2.5.0 | Introduced. |