$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.172

Twitter updates

  • This week ProcessWire gained powerful new tools for finding pages and controlling how they are loaded. If you like to maximize performance and efficiency, you’ll like what 3.0.172 brings— More
    5 February 2021
  • ProcessWire 3.0.171 dev branch core updates – More
    22 January 2021
  • Preliminary 2021 roadmap in progress in this week’s update— More
    8 January 2021

Latest news

  • ProcessWire Weekly #351
    In the 351st issue of ProcessWire Weekly we're going to introduce the latest core updates, check out what's been happening on the support forum, and pick a new site of the week. Read on!
    Weekly.pw / 30 January 2021
  • ProcessWire 3.0.172 – Find faster and more efficiently
    This week ProcessWire gained powerful new tools for finding pages and controlling how they are loaded. If you like to maximize performance and efficiency, you’ll like what 3.0.172 brings.
    Blog / 5 February 2021
  • Subscribe to weekly ProcessWire news

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK