Function __global->generate_csrf_token

Definitions

sources/csrf_filter.php

  • Generate and save a CSRF-token.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: string

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$force_fresh boolean No No False N/A N/A Force a new token to be generated

Returns

  • Generated token
  • Type: ID_TEXT
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Generate and save a CSRF-token.
 *
 * @param  boolean $force_fresh Force a new token to be generated
 * @return ID_TEXT Generated token
 */
function generate_csrf_token(bool $force_fresh = false) : string