session_set_save_handler
callable$open,
callable$close,
callable$read,
callable$write,
callable$destroy,
callable$gc,
[callable$create_sid],
[callable$validate_sid],
[callable$update_timestamp]
): bool
It is possible to register the following prototype:
boolsession_set_save_handler objectsessionhandler boolregister_shutdowntrueParameters
This function has two prototypes.
- sessionhandler
-
An instance of a class implementing SessionHandlerInterface, and optionally SessionIdInterface and/or SessionUpdateTimestampHandlerInterface, such as SessionHandler, to register as the session handler.
- register_shutdown
-
Register session_write_close as a register_shutdown_function function.
- open
-
A callable with the following signature:
open( string$savePath, string$sessionName ): boolThe open callback works like a constructor in classes and is executed when the session is being opened. It is the first callback function executed when the session is started automatically or manually with session_start. Return value is true for success, false for failure.
- close
-
A callable with the following signature:
close( ): boolThe close callback works like a destructor in classes and is executed after the session write callback has been called. It is also invoked when session_write_close is called. Return value should be true for success, false for failure.
- read
-
A callable with the following signature:
read( string$sessionId ): stringThe read callback must always return a session encoded (serialized) string, or an empty string if there is no data to read.
This callback is called internally by PHP when the session starts or when session_start is called. Before this callback is invoked PHP will invoke the open callback.
The value this callback returns must be in exactly the same serialized format that was originally passed for storage to the write callback. The value returned will be unserialized automatically by PHP and used to populate the $_SESSION superglobal. While the data looks similar to serialize please note it is a different format which is specified in the session.serialize_handler ini setting.
- write
-
A callable with the following signature:
write( string$sessionId, string$data ): boolThe write callback is called when the session needs to be saved and closed. This callback receives the current session ID a serialized version the $_SESSION superglobal. The serialization method used internally by PHP is specified in the session.serialize_handler ini setting.
The serialized session data passed to this callback should be stored against the passed session ID. When retrieving this data, the read callback must return the exact value that was originally passed to the write callback.
This callback is invoked when PHP shuts down or explicitly when session_write_close is called. Note that after executing this function PHP will internally execute the close callback.
Note:
The "write" handler is not executed until after the output stream is closed. Thus, output from debugging statements in the "write" handler will never be seen in the browser. If debugging output is necessary, it is suggested that the debug output be written to a file instead.
- destroy
-
A callable with the following signature:
destroy( string$sessionId ): boolThis callback is executed when a session is destroyed with session_destroy or with session_regenerate_id with the destroy parameter set to true. Return value should be true for success, false for failure.
- gc
-
A callable with the following signature:
gc( int$lifetime ): boolThe garbage collector callback is invoked internally by PHP periodically in order to purge old session data. The frequency is controlled by session.gc_probability and session.gc_divisor. The value of lifetime which is passed to this callback can be set in session.gc_maxlifetime. Return value should be true for success, false for failure.
- create_sid
-
A callable with the following signature:
create_sid( ): stringThis callback is executed when a new session ID is required. No parameters are provided, and the return value should be a string that is a valid session ID for your handler.
- validate_sid
-
A callable with the following signature:
validate_sid( string$key ): boolThis callback is executed when a session is to be started, a session ID is supplied and session.use_strict_mode is enabled. The key is the session ID to validate. A session ID is valid, if a session with that ID already exists. The return value should be true for success, false for failure.
- update_timestamp
-
A callable with the following signature:
update_timestamp( string$key, string$val ): boolThis callback is executed when a session is updated. key is the session ID, val is the session data. The return value should be true for success, false for failure.
Return Values
Returns true on success or false on failure.
Notes
Warning:
The write and close handlers are called after object destruction and therefore cannot use objects or throw exceptions. Exceptions are not able to be caught since will not be caught nor will any exception trace be displayed and the execution will just cease unexpectedly. The object destructors can however use sessions.
It is possible to call session_write_close from the destructor to solve this chicken and egg problem but the most reliable way is to register the shutdown function as described above.
Warning:
Current working directory is changed with some SAPIs if session is closed in the script termination. It is possible to close the session earlier with session_write_close.