WP_Filesystem_SSH2::move() WordPress Method

The WP_Filesystem_SSH2::move() method is used to move a file or directory from one location to another on the server. This is done by using the SSH2 protocol to connect to the server and issue the appropriate commands.

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


Top ↑

Return

(bool) True on success, false on failure.


Top ↑

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
VersionDescription
2.7.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.