$session->remove() method

Unset a session variable

Example

// Unset a session var
$session->remove('firstName');

// Unset a session var in a namespace
$session->remove($this, 'firstName');

// Unset all session vars in a namespace
$session->remove($this, true); 

Usage

// basic usage
$session->remove($key);

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

Arguments

NameType(s)Description
keystring, object

Name of session variable you want to remove (or namespace string/object)

_key (optional)string, bool, null

Omit this argument unless first argument is a namespace. Otherwise specify one of:

  • If first argument is namespace and you want to remove a property from the namespace, provide key here.
  • If first argument is namespace and you want to remove all properties from the namespace, provide boolean TRUE.

Return value

$this

Object instance it was called from (method supports fluent interface).


$session methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #522
    In the 522nd issue of ProcessWire Weekly we'll check out the latest core updates, introduce a new module called File Mover, and more. Read on!
    Weekly.pw / 11 May 2024
  • ProFields Table Field with Actions support
    This week we have some updates for the ProFields table field (FieldtypeTable). These updates are primarily focused on adding new tools for the editor to facilitate input and management of content in a table field.
    Blog / 12 April 2024
  • Subscribe to weekly ProcessWire news

“We chose ProcessWire because of its excellent architecture, modular extensibility and the internal API. The CMS offers the necessary flexibility and performance for such a complex website like superbude.de. ProcessWire offers options that are only available for larger systems, such as Drupal, and allows a much slimmer development process.” —xport communication GmbH