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

Moves a file or directory.


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().

Top ↑


$source string Required
Path to the source file or directory.
$destination string Required
Path to the destination file or directory.
$overwrite bool Optional
Whether to overwrite the destination if it exists.

Default: false

Top ↑


bool True on success, false on failure.

Top ↑


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

Top ↑


Version Description
2.7.0 Introduced.

Top ↑

User Contributed Notes

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