session_unset

(PHP 4, PHP 5, PHP 7)

session_unsetFree all session variables

Description

session_unset ( ) : bool

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

Return Values

Returns true on success or false on failure.

Changelog

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

Notes

Note:

If $_SESSION is used, use unset() to unregister a session variable, i.e. unset ($_SESSION['varname']);.

Caution

Do NOT unset the whole $_SESSION with unset($_SESSION) as this will disable the registering of session variables through the $_SESSION superglobal.

Note:

Only use session_unset() for older deprecated code that does not use $_SESSION.

© 1997–2020 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://www.php.net/manual/en/function.session-unset.php