session_reset()

session_reset() — Re-initialize session array with original values.

Built-in function of PHP 8.5. The manual lists it as available in PHP 5 >= 5.6.0, 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

session_reset() reinitializes a session with original values stored in session storage. This function requires an active session and discards changes in $_SESSION.

Signature

session_reset(): bool

Parameters

This function takes no parameters.

Return value

Returns true on success or false on failure.

Example

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

Changelog

VersionChange
7.2.0The return type of this function is bool now. Formerly, it has been void.

See also

session_start(), session_abort(), session_commit()

All PHP 8.5 built-in functions

Reference card built from the PHP manual page session_reset() (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.