On this page
WP_Filesystem_Direct::move( string $source, string $destination, bool $overwrite = false ): bool
Moves a file.
Parameters
$sourcestring Required-
Path to the source file.
$destinationstring Required-
Path to the destination file.
$overwritebool Optional-
Whether to overwrite the destination file if it exists.
Default:
false
Return
bool True on success, false on failure.
Source
File: wp-admin/includes/class-wp-filesystem-direct.php. View all references
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;
}
}
Related
Uses
| Uses | Description |
|---|---|
| WP_Filesystem_Direct::exists() wp-admin/includes/class-wp-filesystem-direct.php | Checks if a file or directory exists. |
| WP_Filesystem_Direct::copy() wp-admin/includes/class-wp-filesystem-direct.php | Copies a file. |
| WP_Filesystem_Direct::delete() wp-admin/includes/class-wp-filesystem-direct.php | Deletes a file or directory. |
Changelog
| Version | Description |
|---|---|
| 2.5.0 | Introduced. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_filesystem_direct/move