$sanitizer->range() method

Sanitize value to be within the given min and max range

If float or decimal string specified for $min or $max arguments, return value will be a float, otherwise an integer is returned.

Available since version 3.0.125.

Example

$n = 10;
$sanitizer->range($n, 100, 200); // returns 100
$sanitizer->range($n, 0, 1.0); // returns 1.0
$sanitizer->range($n, 1.1, 100.5); // returns 10.0

Usage

// basic usage
$int = $sanitizer->range($value);

// usage with all arguments
$int = $sanitizer->range($value, $min = null, $max = null);

Arguments

NameType(s)Description
valueint, float, string
min (optional)int, float, string, null

Minimum allowed value or null for no minimum (default=null)

max (optional)int, float, string, null

Maximum allowed value or null for no maximum (default=null)

Return value

int float


$sanitizer methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #532
    In the 532nd issue of ProcessWire Weekly we'll cover the latest core updates, check out a couple of brand-new third party modules, and more. Read on!
    Weekly.pw / 20 July 2024
  • Page List Custom Children module
    This simple module gives you the ability to customize the parent/child relationship as it appears in the admin page list, enabling child pages to appear under more than one parent.
    Blog / 28 June 2024
  • Subscribe to weekly ProcessWire news

“Indeed, if ProcessWire can be considered as a CMS in its own right, it also offers all the advantages of a CMF (Content Management Framework). Unlike other solutions, the programmer is not forced to follow the proposed model and can integrate his/her ways of doing things.” —Guy Verville, Spiria Digital Inc.