$sanitizer->filename() method

Name filter for ProcessWire filenames (basenames only, not paths)

This sanitizes a filename to be consistent with the name format in ProcessWire, ASCII-alphanumeric (a-z A-Z 0-9), hyphens, underscores and periods. Note that filenames may contain mixed case (a-z A-Z) so if you require lowercase then run the return value through a strtolower() function.

Example

// outputs: FileName.jpg
echo $sanitizer->filename('©®™FileName.jpg');

// outputs: c_r_tmfilename.jpg
echo strtolower($sanitizer->filename('©®™filename.jpg', Sanitizer::translate));

Usage

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

// usage with all arguments
$string = $sanitizer->filename(string $value, $beautify = false, int $maxLength = 128);

Arguments

NameType(s)Description
valuestring

Filename to sanitize

beautify (optional)bool, int

Should be true when creating a file's name for the first time. Default is false. You may also specify Sanitizer::translate (or number 2) for the $beautify param, which will make it translate letters based on the InputfieldPageName custom config settings.

maxLength (optional)int

Maximum number of characters allowed in the filename

Return value

string

Sanitized filename


$sanitizer methods and properties

API reference based on ProcessWire core version 3.0.248

Latest news

  • ProcessWire Weekly #582
    The 582nd issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 5 July 2025
  • New ProcessWire admin redesign
    When you upgrade to ProcessWire 3.0.248 or newer (currently the dev branch), you’ll immediately notice something new and beautiful…
    Blog / 9 May 2025
  • Subscribe to weekly ProcessWire news

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright—Marc Hinse, Web designer/developer