WP_Filesystem_SSH2::move( string $source, string $destination, bool $overwrite = false ): bool
Moves a file or directory.
Description
After moving files or directories, OPcache will need to be invalidated.
If moving a directory fails, copy_dir() can be used for a recursive copy.
Use move_dir() for moving directories with OPcache invalidation and a fallback to copy_dir().
Parameters
-
$sourcestring Required -
Path to the source file or directory.
-
$destinationstring Required -
Path to the destination file or directory.
-
$overwritebool Optional -
Whether to overwrite the destination if it exists.
Default:
false
Return
bool True on success, false on failure.
Source
File: wp-admin/includes/class-wp-filesystem-ssh2.php.
View all references
public function move( $source, $destination, $overwrite = false ) {
if ( $this->exists( $destination ) ) {
if ( $overwrite ) {
// We need to remove the destination 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. |