function hook_file_move in Drupal 9

Same name and namespace in other branches

1. 8 core/modules/file/file.api.php \hook_file_move()
2. 7 modules/system/system.api.php \hook_file_move()
3. 10 core/modules/file/file.api.php \hook_file_move()

Respond to a file that has been moved.

Parameters

\Drupal\file\FileInterface $file: The updated file entity after the move.

\Drupal\file\FileInterface $source: The original file entity before the move.

See also

file_move()

Related topics

2 functions implement hook_file_move()

Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.

file_test_file_move in core/modules/file/tests/file_test/file_test.module

Implements hook_file_move().

image_file_move in core/modules/image/image.module

Implements hook_file_move().

1 invocation of hook_file_move()

file_move in core/modules/file/file.module

Moves a file to a new location and update the file's database entry.

File

core/modules/file/file.api.php, line 117

Hooks for file module.

Code

function hook_file_move(\Drupal\file\FileInterface $file, \Drupal\file\FileInterface $source) {

  // Make sure that the file name starts with the owner's user name.
  if (strpos($file
    ->getFilename(), $file
    ->getOwner()->name) !== 0) {
    $file
      ->setFilename($file
      ->getOwner()->name . '_' . $file
      ->getFilename());
    $file
      ->save();
    \Drupal::logger('file')
      ->notice('Moved file %source has been renamed to %destination', [
      '%source' => $source->filename,
      '%destination' => $file
        ->getFilename(),
    ]);
  }
}