function hook_file_validate

1 system.api.php hook_file_validate(File $file)

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

File $file: The file entity being validated.

Return value

An array of error messages. If there are no problems with the file return: an empty array.

See also

file_validate()

Related topics

Hooks Allow modules to interact with the Backdrop core.

2 functions implement 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_managed_file_validate in core/modules/file/file.module: Render API callback: Validates the managed_file element.
file_test_file_validate in core/modules/simpletest/tests/file_test.module: Implements hook_file_validate().

1 invocation of hook_file_validate()

file_validate in core/includes/file.inc: Checks that a file meets the criteria specified by the validators.

File

core/modules/system/system.api.php, line 2318: Hooks provided by Backdrop core and the System module.

Code

function hook_file_validate(File $file) {
  $errors = array();

  if (empty($file->filename)) {
    $errors[] = t("The file's name is empty. Please give a name to the file.");
  }
  if (strlen($file->filename) > 255) {
    $errors[] = t("The file's name exceeds the 255 characters limit. Please rename the file and try again.");
  }

  return $errors;
}