WireSessionHandler class

Located in file /wire/core/WireSessionHandler.php

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the WireSessionHandler class also inherits all the methods and properties of: WireData and Wire.

Common

Name	Return	Summary
WireSessionHandler::attach() WireSessionHandler::attach() WireSessionHandler::attach()	(nothing)	Attach this as the session handler
WireSessionHandler::close() WireSessionHandler::close() WireSessionHandler::close()	`bool`	Close the session
WireSessionHandler::destroy() WireSessionHandler::destroy(string $id) WireSessionHandler::destroy(string $id)	`bool`	Destroy the session indicated by the given session ID
WireSessionHandler::gc() WireSessionHandler::gc(int $seconds) WireSessionHandler::gc(int $seconds)	`bool`	Garbage collection: remove stale sessions
WireSessionHandler::hookSessionInit() WireSessionHandler::hookSessionInit(HookEvent $event) WireSessionHandler::hookSessionInit(HookEvent $event)	(nothing)	Hook before Session::init
WireSessionHandler::init() WireSessionHandler::init() WireSessionHandler::init()	(nothing)	Initailize, called when module configuration has been populated
WireSessionHandler::isAutoload() WireSessionHandler::isAutoload() WireSessionHandler::isAutoload()	(nothing)	Tells the Modules API to automatically load this module at boot
WireSessionHandler::isSingular() WireSessionHandler::isSingular() WireSessionHandler::isSingular()	(nothing)	Tells the Modules API to only instantiate one instance of this module
WireSessionHandler::open() WireSessionHandler::open(string $path, string $name) WireSessionHandler::open(string $path, string $name)	`bool`	Open the session
WireSessionHandler::read() WireSessionHandler::read(string $id) WireSessionHandler::read(string $id)	`string`	Read and return data for session indicated by $id
WireSessionHandler::sessionExists() WireSessionHandler::sessionExists() WireSessionHandler::sessionExists()	`bool`	Does a session currently exist? (i.e. already one started)
WireSessionHandler::wired() WireSessionHandler::wired() WireSessionHandler::wired()	(nothing)	Initialize the save handler when $modules sets the current instance
WireSessionHandler::write() WireSessionHandler::write(string $id, $data) WireSessionHandler::write(string $id, $data)	(nothing)	Write the given $data for the given session ID

Additional methods and properties

In addition to the methods and properties above, WireSessionHandler also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.236

Located in file /wire/core/WireSessionHandler.php

Common

Additional methods and properties

Newest forum posts

Latest news

Subscribe to weekly ProcessWire news