clamp

(PHP 8 >= 8.6.0)

clamp — Return the given value if in range, else return the nearest bound

Description

function clamp(mixed $value, mixed $min, mixed $max): mixed

Return the given value if in range of min and max. Else if it's lower than min, return min. Else return max.

Note:

Values of different types will be compared using the standard comparison rules. For instance, when a non-numeric string is compared to an int, the int is cast to string and the values are compared as strings. Multiple non-numeric string values are also compared as strings. The actual value returned will be of the original type with no conversion applied.

Caution

Be careful when passing arguments of different types because clamp() can produce unpredictable results.

Parameters

value

Any comparable value to be clamped between min and max.

min

A comparable minimum to limit the value to.

max

A comparable maximum to limit the value to.

Return Values

clamp() returns the parameter value if considered "between" min and max according to standard comparisons.

If value is NAN, then the returned value will also be NAN.

Errors/Exceptions

If min is greater than max, clamp() throws a ValueError.

If min or max is NAN, clamp() throws a ValueError.

Examples

<?php
echo clamp(-5, min: 0, max: 100), PHP_EOL;  // 0
echo clamp(55, min: 0, max: 100), PHP_EOL;  // 55
echo clamp(103, min: 0, max: 100), PHP_EOL;  // 100

echo clamp("J", min: "A", max: "F"), PHP_EOL;  // "F"

echo clamp(
    new \DateTimeImmutable('2025-08-01'),
    min: new \DateTimeImmutable('2025-08-15'),
    max: new \DateTimeImmutable('2025-09-15'),
)->format('Y-m-d'), PHP_EOL; // 2025-08-15
?>

See Also

  • min() - Find lowest value
  • max() - Find highest value