$sanitizermaxLength()

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.251