$sanitizer->minLength() method

Validate or sanitize a string to have a minimum length

If string meets minimum length it is returned as-is.

Note that the default behavior of this function is to validate rather than sanitize the value. Meaning, it will return blank if the string does not meet the minimum length. Specify the $padChar argument to change that behavior.

If string does not meet minimum length, blank will be returned, unless a $padChar is defined in which case the string will be padded with as many copies of that $padChar are necessary to meet the minimum length. By default it padds to the right, but you can specify true for the $padLeft argument to make it pad to the left instead.

Example

$value = $sanitizer->minLength('foo'); // returns "foo"
$value = $sanitizer->minLength('foo', 3); // returns "foo"
$value = $sanitizer->minLength('foo', 5); // returns blank string
$value = $sanitizer->minLength('foo', 5, 'o'); // returns "foooo"
$value = $sanitizer->minLength('foo', 5, 'o', true); // returns "oofoo"

Usage

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

// usage with all arguments
$string = $sanitizer->minLength(string $value, int $minLength = 1, string $padChar = '', bool $padLeft = false);

Arguments

NameType(s)Description
valuestring

Value to enforcer a minimum length for

minLength (optional)int

Minimum allowed length

padChar (optional)string

Pad string with this character if it does not meet minimum length (default='')

padLeft (optional)bool

Pad to left rather than right? (default=false)

Return value

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

“…building with ProcessWire was a breeze, I really love all the flexibility the system provides. I can’t imagine using any other CMS in the future.” —Thomas Aull