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.

Show class?             Show args?        

Common

NameReturnSummary 
attach()
(nothing)Attach this as the session handler 
close()
boolClose the session 
destroy(string $id)
boolDestroy the session indicated by the given session ID 
gc(int $seconds)
boolGarbage collection: remove stale sessions 
hookSessionInit(HookEvent $event)
(nothing)Hook before Session::init 
init()
(nothing)Initailize, called when module configuration has been populated 
isAutoload()
(nothing)Tells the Modules API to automatically load this module at boot 
isSingular()
(nothing)Tells the Modules API to only instantiate one instance of this module 
open(string $path, string $name)
boolOpen the session 
read(string $id)
stringRead and return data for session indicated by $id 
sessionExists()
boolDoes a session currently exist? (i.e. already one started) 
wired()
(nothing)Initialize the save handler when $modules sets the current instance 
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.244

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright” —Marc Hinse, Web designer/developer