array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'en', ), 'this' => array ( 0 => 'sessionhandler.read.php', 1 => 'SessionHandler::read', 2 => 'Read session data', ), 'up' => array ( 0 => 'class.sessionhandler.php', 1 => 'SessionHandler', ), 'prev' => array ( 0 => 'sessionhandler.open.php', 1 => 'SessionHandler::open', ), 'next' => array ( 0 => 'sessionhandler.write.php', 1 => 'SessionHandler::write', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'en', 'path' => 'reference/session/sessionhandler/read.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

SessionHandler::read

(PHP 5 >= 5.4.0, PHP 7, PHP 8)

SessionHandler::read — Read session data

Description

public SessionHandler::read(string $id): string|false

Reads the session data from the session storage, and returns the result back to PHP for internal processing. This method is called automatically by PHP when a session is started (either automatically or explicitly with session_start() and is preceded by an internal call to the SessionHandler::open().

This method wraps the internal PHP save handler defined in the session.save_handler ini setting that was set before this handler was set by session_set_save_handler().

If this class is extended by inheritance, calling the parent read method will invoke the wrapper for this method and therefore invoke the associated internal callback. This allows the method to be overridden and or intercepted and filtered (for example, decrypting the $data value returned by the parent read method).

For more information on what this method is expected to do, please refer to the documentation at SessionHandlerInterface::read().

Parameters

id

The session id to read data for.

Return Values

Returns an encoded string of the read data. If nothing was read, it must return false. Note this value is returned internally to PHP for processing.

See Also