$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.200

Twitter updates

  • New blog: Debugging tools built-in to ProcessWire. ProcessWire's core comes with a lot of helpful debugging tools and capabilities built-in. In this post we'll cover some of these useful tools and how to use them… More
    1 July 2022
  • A review of weekly core updates, plus a simple recipe for a very effective listing cache—More
    24 June 2022
  • Weekly update: Making ProcessWire render pages at old WordPress URLs (or building a simple/custom URL router in PW): More
    17 June 2022

Latest news

  • ProcessWire Weekly #424
    In the 424th issue of ProcessWire Weekly we'll check out the latest weekly update from Ryan, introduce a new third party module, and more. Read on!
    Weekly.pw / 25 June 2022
  • Debugging tools built into ProcessWire
    ProcessWire's core comes with a lot of helpful debugging tools and capabilities built-in. In this post we'll cover some of these useful tools and how to use them.
    Blog / 1 July 2022
  • 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