$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 #554
    In the 554th issue of ProcessWire Weekly we'll check out the latest core updates, introduce a couple of new third party modules, and more. Read on!
    Weekly.pw / 21 December 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

“The end client and designer love the ease at which they can update the website. Training beyond how to log in wasn’t even necessary since ProcessWire’s default interface is straightforward.” —Jonathan Lahijani