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 
WireSessionHandler::attach()
(nothing)Attach this as the session handler 
WireSessionHandler::close()
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 
WireSessionHandler::init()
(nothing)Initailize, called when module configuration has been populated 
WireSessionHandler::isAutoload()
(nothing)Tells the Modules API to automatically load this module at boot 
WireSessionHandler::isSingular()
(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 
WireSessionHandler::sessionExists()
boolDoes a session currently exist? (i.e. already one started) 
WireSessionHandler::wired()
(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.236

Latest news

  • ProcessWire Weekly #515
    In the 515th issue of ProcessWire Weekly we’ll check out the latest core updates, new modules, and more. Read on!
    Weekly.pw / 23 March 2024
  • Invoices Site Profile
    The new invoices site profile is a free invoicing application developed in ProcessWire. It enables you to create invoices, record payments to them, email invoices to clients, print invoices, and more. This post covers all the details.
    Blog / 15 March 2024
  • Subscribe to weekly ProcessWire news

“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