$sanitizer->maxLength() method

Limit length of given value to that specified

  • For strings, this limits the length to that many characters.
  • For arrays, the maxLength is assumed to be the max allowed array items.
  • For integers maxLength is assumed to be the max allowed digits.
  • For floats, maxLength is assumed to be max allowed digits (including decimal point).
  • Returns the same type it is given: string, array, int or float

Available since version 3.0.125.

Usage

// basic usage
$array = $sanitizer->maxLength($value);

// usage with all arguments
$array = $sanitizer->maxLength($value, int $maxLength = 128, $maxBytes = null);

Arguments

NameType(s)Description
valuestring, int, array, float
maxLength (optional)int

Maximum length (default=128)

maxBytes (optional)null, int

Maximum allowed bytes (used for string types only)

Return value

array float int string

See Also


$sanitizer methods and properties

API reference based on ProcessWire core version 3.0.244

Latest news

  • ProcessWire Weekly #559
    The 559th issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 25 January 2025
  • ProcessWire 3.0.244 new main/master version
    ProcessWire 3.0.244 is our newest main/master/stable version. It's been more than a year in the making and is packed with tons of new features, issue fixes, optimizations and more. This post covers all the details.
    Blog / 18 January 2025
  • 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