session_write_close()

session_write_close() — Write session data and end session.

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

Signature

session_write_close(): bool

Parameters

This function takes no parameters.

Return value

Returns false if no session is active, true otherwise. true is also returned if the save handler fails to write the session data.

Example

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

Changelog

VersionChange
8.5.0If $_SESSION contains a key with a pipe character (|), an E_WARNING is now emitted. Previously, this would silently fail to write the session data.
7.2.0The return type of this function is bool now. Formerly, it has been void.

See also

session_register_shutdown(), session_start(), session_abort()

All PHP 8.5 built-in functions

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