function hook_file_validate in Drupal 9
Same name and namespace in other branches
- 8 core/modules/file/file.api.php \hook_file_validate()
- 7 modules/system/system.api.php \hook_file_validate()
Check that files meet a given criteria.
This hook lets modules perform additional validation on files. They're able to report a failure by returning one or more error messages.
Parameters
\Drupal\file\FileInterface $file: The file entity being validated.
Return value
array An array of error messages. If there are no problems with the file return an empty array.
See also
Related topics
1 function implements hook_file_validate()
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_validate in core/
modules/ file/ tests/ file_test/ file_test.module - Implements hook_file_validate().
1 invocation of hook_file_validate()
- file_validate in core/
modules/ file/ file.module - Checks that a file meets the criteria specified by the validators.
File
- core/
modules/ file/ file.api.php, line 74 - Hooks for file module.
Code
function hook_file_validate(\Drupal\file\FileInterface $file) {
$errors = [];
if (!$file
->getFilename()) {
$errors[] = t("The file's name is empty. Please give a name to the file.");
}
if (strlen($file
->getFilename()) > 255) {
$errors[] = t("The file's name exceeds the 255 characters limit. Please rename the file and try again.");
}
return $errors;
}