SessionCSRF::getSingleUseToken() method

Get a CSRF Token name and value that can only be used once

Note that a single call to hasValidToken($id) or validate($id) will invalidate the single use token. So call them once and store your result if you need the result multiple times.

Usage

// basic usage
$array = $sessionCSRF->getSingleUseToken();

// usage with all arguments
$array = $sessionCSRF->getSingleUseToken($id = '');

Arguments

NameType(s)Description
id (optional)int, string

Optional unique ID/name for this token (of omitted one is generated automatically)

Return value

array

("id' => "token ID", "name" => "token name", "value" => "token value", "time" => created timestamp)


SessionCSRF methods and properties

API reference based on ProcessWire core version 3.0.244

Latest news

  • ProcessWire Weekly #560
    In the 560th issue of ProcessWire Weekly we'll check out the latest core updates, cover newly released ProcessWire modules, and more. Read on!
    Weekly.pw / 1 February 2025
  • ProcessWire 3.0.244 new main/master version
    ProcessWire 3.0.244 is our newest main/master/stable version. It's been more than a year in the making and is packed with tons of new features, issue fixes, optimizations and more. This post covers all the details.
    Blog / 18 January 2025
  • Subscribe to weekly ProcessWire news

I just love the easy and intuitive ProcessWire API. ProcessWire rocks!” —Jens Martsch, Web developer