$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 #554
    In the 554th issue of ProcessWire Weekly we'll check out the latest core updates, introduce a couple of new third party modules, and more. Read on!
    Weekly.pw / 21 December 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

“Indeed, if ProcessWire can be considered as a CMS in its own right, it also offers all the advantages of a CMF (Content Management Framework). Unlike other solutions, the programmer is not forced to follow the proposed model and can integrate his/her ways of doing things.” —Guy Verville, Spiria Digital Inc.