$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 bool float int string

See Also


$sanitizer methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #549
    In the 549th issue of ProcessWire Weekly we’re going to check out the latest core updates, highlight one older yet still very relevant third party module, and more. Read on!
    Weekly.pw / 17 November 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • 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