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

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