$session->get() method

Get a session variable

  • This method returns the value of the requested session variable, or NULL if it's not present.
  • You can optionally use a namespace with this method, to avoid collisions with other session variables. But if using namespaces we recommended using the dedicated getFor() and setFor() methods instead.
  • You can also get or set non-namespaced session values directly (see examples).

Examples

// Set value "Bob" to session variable named "firstName"
$session->set('firstName', 'Bob');

// You can retrieve the firstName now, or any later request
$firstName = $session->get('firstName');

// outputs: Hello Bob
echo "Hello $firstName"; 
// Setting and getting a session value directly
$session->firstName = 'Bob';
$firstName = $session->firstName;

Usage

// basic usage
$mixed = $session->get($key);

// usage with all arguments
$mixed = $session->get($key, string $_key = null);

Arguments

NameType(s)Description
keystring, object

Name of session variable to retrieve (or object if using namespaces)

_key (optional)string

Name of session variable to get if first argument is namespace, omit otherwise.

Return value

mixed

Returns value of seession variable, or NULL if not found.


$session methods and properties

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

“I am currently managing a ProcessWire site with 2 million+ pages. It’s admirably fast, and much, much faster than any other CMS we tested.” —Nickie, Web developer