WP_Filesystem_SSH2::move( string $source, string $destination, bool $overwrite = false )

Moves a file.

Description Description

Parameters Parameters


(string) (Required) Path to the source file.


(string) (Required) Path to the destination file.


(bool) (Optional) Whether to overwrite the destination file if it exists.

Default value: false

Top ↑

Return Return

(bool) True on success, false on failure.

Top ↑

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

Top ↑

Changelog Changelog

Version Description
2.7.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.