Php/docs/function.min

From Get docs

min

(PHP 4, PHP 5, PHP 7)

minFind lowest value


Description

min ( array $value_array ) : mixed

min ( mixed $value , mixed ...$values ) : mixed

If the first and only parameter is an array, min() returns the lowest value in that array. If at least two parameters are provided, min() returns the smallest of these values.

Note:

Values of different types will be compared using the standard comparison rules. For instance, a non-numeric string will be compared to an int as though it were 0, but multiple non-numeric string values will be compared alphanumerically. The actual value returned will be of the original type with no conversion applied.

Caution Be careful when passing arguments with mixed types values because min() can produce unpredictable results.


Parameters

value_array
An array containing the values.
value
Any comparable value.
values
Any comparable values.


Return Values

min() returns the parameter value considered "lowest" according to standard comparisons. If multiple values of different types evaluate as equal (e.g. 0 and 'abc') the first provided to the function will be returned.

If an empty array is passed, then FALSE will be returned and an E_WARNING error will be emitted.


Examples

Example #1 Example uses of min()

<?phpecho min(2, 3, 1, 6, 7);  // 1echo min(array(2, 4, 5)); // 2// The string 'hello' when compared to an int is treated as 0// Since the two values are equal, the order they are provided determines the resultecho min(0, 'hello');     // 0echo min('hello', 0);     // hello// Here we are comparing -1 < 0, so -1 is the lowest valueecho min('hello', -1);    // -1// With multiple arrays of different lengths, min returns the shortest$val = min(array(2, 2, 2), array(1, 1, 1, 1)); // array(2, 2, 2)// Multiple arrays of the same length are compared from left to right// so in our example: 2 == 2, but 4 < 5$val = min(array(2, 4, 8), array(2, 5, 1)); // array(2, 4, 8)// If both an array and non-array are given, the array is never returned// as comparisons treat arrays as greater than any other value$val = min('string', array(2, 5, 7), 42);   // string// If one argument is NULL or a boolean, it will be compared against// other values using the rules FALSE < TRUE and NULL == FALSE regardless of the // other types involved// In the below examples, both -10 and 10 are treated as TRUE in the comparison$val = min(-10, FALSE, 10); // FALSE$val = min(-10, NULL, 10);  // NULL// 0, on the other hand, is treated as FALSE, so is "lower than" TRUE$val = min(0, TRUE); // 0?>

See Also

  • max() - Find highest value
  • count() - Count all elements in an array, or something in an object