On this page
WP_Filesystem_FTPext::copy( string $source, string $destination, bool $overwrite = false, int|false $mode = false ): bool
Copies a file.
Parameters
$sourcestring Required-
Path to the source file.
$destinationstring Required-
Path to the destination file.
$overwritebool Optional-
Whether to overwrite the destination file if it exists.
Default:
false $modeint|false Optional-
The permissions as octal number, usually 0644 for files, 0755 for dirs.
Default:
false
Return
bool True on success, false on failure.
Source
File: wp-admin/includes/class-wp-filesystem-ftpext.php. View all references
public function copy( $source, $destination, $overwrite = false, $mode = false ) {
if ( ! $overwrite && $this->exists( $destination ) ) {
return false;
}
$content = $this->get_contents( $source );
if ( false === $content ) {
return false;
}
return $this->put_contents( $destination, $content, $mode );
}
Related
Uses
| Uses | Description |
|---|---|
| WP_Filesystem_FTPext::exists() wp-admin/includes/class-wp-filesystem-ftpext.php | Checks if a file or directory exists. |
| WP_Filesystem_FTPext::get_contents() wp-admin/includes/class-wp-filesystem-ftpext.php | Reads entire file into a string. |
| WP_Filesystem_FTPext::put_contents() wp-admin/includes/class-wp-filesystem-ftpext.php | Writes a string to a file. |
Changelog
| Version | Description |
|---|---|
| 2.5.0 | Introduced. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_filesystem_ftpext/copy