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?        


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

Latest news

  • ProcessWire Weekly #498
    The 498th issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 25 November 2023
  • Using date range fields in ProcessWire
    This week we'll take a detailed look at the newest addition to the ProFields set of modules: the Date Range Fieldtype and Inputfield.
    Blog / 24 November 2023
  • Subscribe to weekly ProcessWire news

I just love the easy and intuitive ProcessWire API. ProcessWire rocks!” —Jens Martsch, Web developer