session_unset()

session_unset() — Free all session variables.

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

The session_unset() function frees all session variables currently registered.

Signature

session_unset(): 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_unset(); 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.

All PHP 8.5 built-in functions

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