WP_Filesystem_SSH2::move( string $source, string $destination, bool $overwrite = false )
Moves 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
Return
(bool) True on success, false on failure.
Source
File: wp-admin/includes/class-wp-filesystem-ssh2.php
public function move( $source, $destination, $overwrite = false ) { if ( $this->exists( $destination ) ) { if ( $overwrite ) { // We need to remove the destination file before we can rename the source. $this->delete( $destination, false, 'f' ); } else { // If we're not overwriting, the rename will fail, so return early. return false; } } return ssh2_sftp_rename( $this->sftp_link, $source, $destination ); }
Changelog
Version | Description |
---|---|
2.7.0 | Introduced. |
© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_filesystem_ssh2/move