WP_Filesystem_Direct::move() WordPress Method

The move() method is used to move a file or directory from one location to another. This is a wrapper for the PHP rename() function.

WP_Filesystem_Direct::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-direct.php

	public function move( $source, $destination, $overwrite = false ) {
		if ( ! $overwrite && $this->exists( $destination ) ) {
			return false;
		}

		// Try using rename first. if that fails (for example, source is read only) try copy.
		if ( @rename( $source, $destination ) ) {
			return true;
		}

		if ( $this->copy( $source, $destination, $overwrite ) && $this->exists( $destination ) ) {
			$this->delete( $source );

			return true;
		} else {
			return false;
		}
	}


Top ↑

Changelog

Changelog
VersionDescription
2.5.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.