WP_Filesystem_SSH2::copy() WordPress Method
The WP_Filesystem_SSH2::copy() function is used to copy a file from one location to another. This function accepts two parameters: the source file and the destination file. The source file must be a valid path to a file on the server and the destination file must be a valid path to a file on the server. This function will return true on success or false on failure.
WP_Filesystem_SSH2::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-ssh2.php
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 ); }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
2.7.0 | Introduced. |