$sanitizer->validateFile() method

Validate a file using FileValidator modules

Note that this is intended for validating file data, not file names.

IMPORTANT: This method returns NULL if it can't find a validator for the file. This does not mean the file is invalid, just that it didn't have the tools to validate it.

Usage

// basic usage
$bool = $sanitizer->validateFile(string $filename);

// usage with all arguments
$bool = $sanitizer->validateFile(string $filename, array $options = []);

Arguments

NameType(s)Description
filenamestring

Full path and filename to validate

options (optional)array

When available, provide array with any one or all of the following:

  • page (Page): Page object associated with $filename.
  • field (Field): Field object associated with $filename.
  • pagefile (Pagefile): Pagefile object associated with $filename.

Return value

bool null

Returns TRUE if valid, FALSE if not, or NULL if no validator available for given file type.


$sanitizer methods and properties

API reference based on ProcessWire core version 3.0.163

Twitter updates

  • This week we’re proud to announce the newest ProcessWire master version 3.0.164. Relative to the previous master (3.0.148) this version adds a ton of new & useful features and fixes more than 85 issues, with more than 225 commits over 7 months— More
    7 August 2020
  • ProcessWire 3.0.163 resolves more than a dozen issue reports and adds new hooks and configurable module install options, among numerous other updates. In addition, a major update to ProCache (v4.0) has been released— More
    24 July 2020
  • Weekly update for 17 July 2020 and a look at new features coming in next week's version of ProCache— More
    17 July 2020

Latest news

  • ProcessWire Weekly #326
    In the 326th issue of ProcessWire Weekly we're going to introduce the latest ProcessWire master version, take a quick look at a brand new third party module called Textformatter Video Markup, and more. Read on!
    Weekly.pw / 8 August 2020
  • ProcessWire 3.0.164 new master version
    This week we’re proud to announce the newest ProcessWire master version 3.0.164. Relative to the previous master version (3.0.148) this version adds a ton of new and useful features and fixes more than 85 issues, with more than 225 commits over a period of 7 months.
    Blog / 7 August 2020
  • Subscribe to weekly ProcessWire news

“ProcessWire is like a breath of fresh air. So powerful yet simple to build with and customise, and web editors love it too.” —Margaret Chatwin, Web developer