WordPress at Your Fingertips
function is not described

WP_Filesystem_SSH2::move() public WP 2.7.0

Moves a file.

{} It's a method of the class: WP_Filesystem_SSH2{}

No Hooks.

Return

true|false. True on success, false on failure.

Usage

$WP_Filesystem_SSH2 = new WP_Filesystem_SSH2();
$WP_Filesystem_SSH2->move( $source, $destination, $overwrite );
$source(string) (required)
Path to the source file.
$destination(string) (required)
Path to the destination file.
$overwrite(true|false)
Whether to overwrite the destination file if it exists.
Default: false

Changelog

Since 2.7.0 Introduced.

Code of WP_Filesystem_SSH2::move() WP 5.8.2

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 );
}