function file_unmanaged_move in Drupal 8
Same name and namespace in other branches
- 7 includes/file.inc \file_unmanaged_move()
Moves a file to a new location without database changes or hook invocation.
This is a powerful function that in many ways performs like an advanced version of rename().
- Checks if $source and $destination are valid and readable/writable.
- Checks that $source is not equal to $destination; if they are an error is reported.
- If file already exists in $destination either the call will error out, replace the file or rename the file based on the $replace parameter.
- Works around a PHP bug where rename() does not properly support streams if safe_mode or open_basedir are enabled.
Parameters
$source: A string specifying the filepath or URI of the source file.
$destination: A URI containing the destination that $source should be moved to. The URI may be a bare filepath (without a scheme) and in that case the default scheme (file://) will be used. If this value is omitted, Drupal's default files scheme will be used, usually "public://".
$replace: Replace behavior when the destination file already exists:
- FILE_EXISTS_REPLACE - Replace the existing file.
- FILE_EXISTS_RENAME - Append _{incrementing number} until the filename is unique.
- FILE_EXISTS_ERROR - Do nothing and return FALSE.
Return value
The path to the new file, or FALSE in the event of an error.
Deprecated
in drupal:8.7.0 and is removed from drupal:9.0.0. Use \Drupal\Core\File\FileSystemInterface::move().
See also
https://bugs.php.net/bug.php?id=60456
https://www.drupal.org/node/3006851
Related topics
1 call to file_unmanaged_move()
- FileSystemDeprecationTest::testDeprecatedUnmanagedFileMove in core/
tests/ Drupal/ KernelTests/ Core/ File/ FileSystemDeprecationTest.php - @expectedDeprecation file_directory_temp() is deprecated in drupal:8.8.0 and is removed from drupal:9.0.0. Use \Drupal\Core\File\FileSystemInterface::getTempDirectory() instead. See https://www.drupal.org/node/3039255 @expectedDeprecation…
File
- core/
includes/ file.inc, line 630 - API for handling file uploads and server file management.
Code
function file_unmanaged_move($source, $destination = NULL, $replace = FILE_EXISTS_RENAME) {
@trigger_error('file_unmanaged_move() is deprecated in Drupal 8.7.0 and will be removed before Drupal 9.0.0. Use \\Drupal\\Core\\File\\FileSystemInterface::move(). See https://www.drupal.org/node/3006851.', E_USER_DEPRECATED);
try {
$file_system = \Drupal::service('file_system');
// Build a destination URI if necessary.
if (!isset($destination)) {
$destination = file_build_uri($file_system
->basename($source));
}
return $file_system
->move($source, $destination, $replace);
} catch (FileException $e) {
return FALSE;
}
}