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.248

Latest news

  • ProcessWire Weekly #581
    The 581st issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 28 June 2025
  • New ProcessWire admin redesign
    When you upgrade to ProcessWire 3.0.248 or newer (currently the dev branch), you’ll immediately notice something new and beautiful…
    Blog / 9 May 2025
  • 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