move_dir() – Function | Developer.WordPress.org

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

 * 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.
 *
 * @since 6.2.0
 *
 * @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
 *
 * @param string $from      Source directory.
 * @param string $to        Destination directory.
 * @param bool   $overwrite Optional. Whether to overwrite the destination directory if it exists.
 *                          Default false.
 * @return true|WP_Error True on success, WP_Error on failure.
 */
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;

View all references View on Trac View on GitHub

Changelog

Version	Description
6.2.0	Introduced.

User Contributed Notes

Shail Mehta 2 years ago

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

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

In this article