Error message

You are browsing documentation for drupal 7.x, which is not supported anymore. Read the updated version of this page for drupal 11.x (the latest version).

function hook_file_update

Respond to a file being updated.

This hook is called when file_save() is called on an existing file.

Parameters

$file: The file that has just been updated.

See also

file_save()

Related topics

Hooks
Allow modules to interact with the Drupal core.
4 functions implement hook_file_update()

Note: the procedural functions in this list are found by pattern matching, so the list may include some functions that are not actually implementations of this hook.

EntityCrudHookTestHooks::fileUpdate in core/modules/system/tests/modules/entity_crud_hook_test/src/Hook/EntityCrudHookTestHooks.php
Implements hook_ENTITY_TYPE_update() for file entities.
entity_crud_hook_test_file_update in modules/simpletest/tests/entity_crud_hook_test.module
Implements hook_file_update().
FileTestHooks::fileUpdate in core/modules/file/tests/file_test/src/Hook/FileTestHooks.php
Implements hook_ENTITY_TYPE_update() for file entities.
file_test_file_update in modules/simpletest/tests/file_test.module
Implements hook_file_update().
1 invocation of hook_file_update()
file_save in includes/file.inc
Saves a file object to the database.

File

modules/system/system.api.php, line 2922

Code

function hook_file_update ($file) {
 $file_user = user_load ($file->uid);
 // Make sure that the file name starts with the owner's user name.
 if (strpos ($file->filename , $file_user->name ) !== 0) {
 $old_filename = $file->filename ;
 $file->filename  = $file_user->name  . '_' . $file->filename ;
 $file->save();
 watchdog ('file', '%source has been renamed to %destination', array(
 '%source' => $old_filename,
 '%destination' => $file->filename ,
 ));
 }
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.