WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

move_dir()

move_dir( string $from, string $to, bool $overwrite = false ): true|WP_Error

In this article

Back to top

Moves a directory from one location to another.

Description

Recursively invalidates OPcache on success.

If the renaming failed, falls back to copy_dir() .

Assumes that WP_Filesystem() has already been called and setup.

This function is not designed to merge directories, copy_dir() should be used instead.

Parameters

$fromstringrequired
Source directory.
$tostringrequired
Destination directory.
$overwritebooloptional
Whether to overwrite the destination directory if it exists.

Default:false

Return

true|WP_Error True on success, WP_Error on failure.

Source

function move_dir( $from, $to, $overwrite = false ) {
	global $wp_filesystem;

	if ( trailingslashit( strtolower( $from ) ) === trailingslashit( strtolower( $to ) ) ) {
		return new WP_Error( 'source_destination_same_move_dir', __( 'The source and destination are the same.' ) );
	}

	if ( $wp_filesystem->exists( $to ) ) {
		if ( ! $overwrite ) {
			return new WP_Error( 'destination_already_exists_move_dir', __( 'The destination folder already exists.' ), $to );
		} elseif ( ! $wp_filesystem->delete( $to, true ) ) {
			// Can't overwrite if the destination couldn't be deleted.
			return new WP_Error( 'destination_not_deleted_move_dir', __( 'The destination directory already exists and could not be removed.' ) );
		}
	}

	if ( $wp_filesystem->move( $from, $to ) ) {
		/*
		 * When using an environment with shared folders,
		 * there is a delay in updating the filesystem's cache.
		 *
		 * This is a known issue in environments with a VirtualBox provider.
		 *
		 * A 200ms delay gives time for the filesystem to update its cache,
		 * prevents "Operation not permitted", and "No such file or directory" warnings.
		 *
		 * This delay is used in other projects, including Composer.
		 * @link https://github.com/composer/composer/blob/2.5.1/src/Composer/Util/Platform.php#L228-L233
		 */
		usleep( 200000 );
		wp_opcache_invalidate_directory( $to );

		return true;
	}

	// Fall back to a recursive copy.
	if ( ! $wp_filesystem->is_dir( $to ) ) {
		if ( ! $wp_filesystem->mkdir( $to, FS_CHMOD_DIR ) ) {
			return new WP_Error( 'mkdir_failed_move_dir', __( 'Could not create directory.' ), $to );
		}
	}

	$result = copy_dir( $from, $to, array( basename( $to ) ) );

	// Clear the source directory.
	if ( true === $result ) {
		$wp_filesystem->delete( $from, true );
	}

	return $result;
}

View all references View on Trac View on GitHub

UsesDescription
wp_opcache_invalidate_directory()wp-admin/includes/file.php

Attempts to clear the opcode cache for a directory of files.

copy_dir()wp-admin/includes/file.php

Copies a directory from one location to another via the WordPress Filesystem Abstraction.

trailingslashit()wp-includes/formatting.php

Appends a trailing slash.

WP_Error::__construct()wp-includes/class-wp-error.php

Initializes the error.

Show 2 moreShow less
Used byDescription
WP_Upgrader::move_to_temp_backup_dir()wp-admin/includes/class-wp-upgrader.php

Moves the plugin or theme being updated into a temporary backup directory.

WP_Upgrader::restore_temp_backup()wp-admin/includes/class-wp-upgrader.php

Restores the plugin or theme from temporary backup.

WP_Upgrader::install_package()wp-admin/includes/class-wp-upgrader.php

Install a package.

Changelog

VersionDescription
6.2.0Introduced.

User Contributed Notes

  1. Skip to note 2 content
    Shail Mehta
    You must log in to vote on the helpfulness of this noteVote results for this note: 2You must log in to vote on the helpfulness of this note
    // Connecting to the filesystem.

if ( ! WP_Filesystem() ) {
    // Unable to connect to the filesystem, FTP credentials may be required or something.
    exit;
}

global $wp_filesystem;

// From Directory Path 
$from = '/path/to/from_folder_name';

// To Directory Path 
$to = '/path/to/to_folder_name';

$result = move_dir($from, $to);

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