FieldtypeFile::getValidFileExtensions()

Check file extensions for given field and return array of validity information

Available since version 3.0.167.

Usage

// basic usage
$array = $fieldtypeFile->getValidFileExtensions($field);

// usage with all arguments
$array = $fieldtypeFile->getValidFileExtensions($field, array $validateExtensions = []);

Arguments

NameType(s)Description
$fieldField Inputfield
$validateExtensions (optional)array

Extensions to require validation for, or omit for default.

Return value

array

Returns associative array with the following:

  • valid (array): valid extensions, including those that have been whitelisted or are covered by FileValidator modules.
  • invalid (array): extensions that are potentially bad and have not been whitelisted or covered by a FileValidator module.
  • whitelist (array): previously invalid extensions that have been manually whitelisted.
  • validators (array): Associative array of [ 'ext' => [ 'FileValidatorModule' ] ] showing what’s covered by FileValidator modules.

Exceptions

Method can throw exceptions on error:

  • WireException

FieldtypeFile methods and properties

API reference based on ProcessWire core version 3.0.252