mt_getrandmax()

mt_getrandmax() — Show largest possible random value.

Built-in function of PHP 8.5. The manual lists it as available in PHP 4, PHP 5, PHP 7, PHP 8. This page is the reference card: signature, parameters and return value, plus the changelog and the example the manual provides.

What it does

Returns the maximum value that can be returned by a call to mt_rand().

Signature

mt_getrandmax(): int

Parameters

This function takes no parameters.

Return value

Returns the maximum random value returned by a call to mt_rand() without arguments, which is the maximum value that can be used for its max parameter without the result being scaled up (and therefore less random).

Example

The PHP manual ships no example for mt_getrandmax(); the signature and the parameter table above are the contract.

See also

mt_rand(), mt_srand(), getrandmax()

All PHP 8.5 built-in functions

Reference card built from the PHP manual page mt_getrandmax() (PHP documentation, CC BY 3.0). The page is generated from the manual, so the wording of the parameter and return value text follows php.net.