Back to Form class

Method csrf

public static void
csrf
(mixed $name = 'csrf.token')
Add CSRF form token to Joomla script options that developers can get it by Javascript.
Parameters
  • string $name The script option key name.
Returns
  • void
Since
  • 3.8.0
Class: Form
Project: Joomla

Method csrf - Source code

/**
 * Add CSRF form token to Joomla script options that developers can get it by Javascript.
 *
 * @param   string  $name  The script option key name.
 *
 * @return  void
 *
 * @since   3.8.0
 */
public static function csrf($name = 'csrf.token')
{
    if (isset(static::$loaded[__METHOD__][$name])) {
        return;
    }
    /** @var HtmlDocument $doc */
    $doc = Factory::getDocument();
    if (!$doc instanceof HtmlDocument || $doc->getType() !== 'html') {
        return;
    }
    $doc->addScriptOptions($name, Session::getFormToken());
    static::$loaded[__METHOD__][$name] = true;
}