Home/ Manual/ gmp / functions/ gmp_random_seed

gmp_random_seed

PHP function Edit on GitHub ✎

(PHP 7, PHP 8)

Sets the RNG seed

Description

gmp_random_seed(GMP|int|string $seed): void

Parameters

seed

The seed to be set for the gmp_random(), gmp_random_bits(), and gmp_random_range() functions.

Parameter

Return Values

Void

Errors/Exceptions

Throws a ValueError if seed is invalid.

Changelog

Version	Description
8.0.0	If `seed` is invalid, `gmp_random_seed()` now throws a `ValueError`. Previously it emitted an `E_WARNING` and returned false.

Examples

gmp_random_seed() example

php

<?php
// set the seed
gmp_random_seed(100);

var_dump(gmp_strval(gmp_random(1)));

// set the seed to something else
gmp_random_seed(gmp_init(-100));

var_dump(gmp_strval(gmp_random_bits(10)));

// set the seed to something invalid
var_dump(gmp_random_seed('not a number'));

The above example will output:

output

string(20) "15370156633245019617"
string(3) "683"

Warning: gmp_random_seed(): Unable to convert variable to GMP - string is not an integer in %s on line %d
bool(false)