session() function
Get or set values in the current user session ($session API variable as a function)
This function behaves the same as the $session API variable, though does support
optional shortcut arguments for getting or setting values.
Please note this method is and thus not intended to be called directly.
Example
// Get a value from the session
$foo = session()->foo; // direct syntax
$foo = session()->get('foo'); // regular syntax
$foo = session('foo'); // shortcut syntax
// Set a value to the session
session()->foo = 'bar'; // direct syntax
session()->set('foo', 'bar'); // regular syntax
session('foo', 'bar'); // shortcut syntaxInternal usage
// basic internal usage
$session = session();
// internal usage with all arguments
$session = session(string $key = '', null $value = null);Arguments
| Name | Type(s) | Description |
|---|---|---|
$key (optional) | string | Optional property to get or set |
$value (optional) | null | Optional value to set |
Return value
Session null string array int float
Functions methods and properties
API reference based on ProcessWire core version 3.0.251