session_encode()

session_encode() — Encodes the current session data as a session encoded string.

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

session_encode() returns a serialized string of the contents of the current session data stored in the $_SESSION superglobal.

Signature

session_encode(): string|false

Parameters

This function takes no parameters.

Return value

Returns the contents of the current session encoded, or false on failure.

Example

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

See also

session_decode()

All PHP 8.5 built-in functions

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