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

Twitter updates

  • New ProcessWire query expansion search operators can now add automatic word inflections and lemmatisation, enabling you to build even smarter search engines with ProcessWire. More
    3 July 2020
  • ProcessWire 3.0.161 adds support for selector operator stacking, enabling you automatically broaden searches in a single pages.find() call— More
    26 June 2020
  • ProcessWire 3.0.160 adds powerful new text-searching operators, bringing a new level of power to page-finding API calls, especially when it comes to search engine type queries. Post also includes a demo search engine where you can test it all out live— More
    19 June 2020

Latest news

  • ProcessWire Weekly #321
    In the 321st issue of ProcessWire Weekly we're going to check out the latest core updates, introduce two new third party modules, and check out a brand new site of the week. Read on!
    Weekly.pw / 4 July 2020
  • Powerful new text-searching abilities in 3.0.160
    In ProcessWire 3.0.160 we’ve got some major upgrades and additions to our text-search abilities. This brings a whole new level of power to $pages->find() and similar API calls, especially when it comes to search engine type queries.
    Blog / 19 June 2020
  • Subscribe to weekly ProcessWire news

“We chose ProcessWire because of its excellent architecture, modular extensibility and the internal API. The CMS offers the necessary flexibility and performance for such a complex website like superbude.de. ProcessWire offers options that are only available for larger systems, such as Drupal, and allows a much slimmer development process.” —xport communication GmbH