Tfa::startUser() method

Start two-factor authentication for User

Modules must implement this method unless they do not need to generate or send authentication codes to the user. Below are details on how to implement this method:

A. For modules that generate and validate their own authentication codes:

  1. Generate an authentication code for user
  2. Save the code to session
  3. Send the code to the user via whatever TFA channel is used
  4. Call parent::startUser($user)
  5. Return true (if no errors)

B. For modules that use an external service to generate, send and validate codes:

  1. Call on the external service to generate and the code to user
  2. Call parent::startUser($user)
  3. Return true (if no errors)

C. Modules that do not generate or send codes, but only validate them (i.e. TOTP): You can omit implementation, leaving just the built-in one below. But if you do implement it, make sure you call the parent::startUser($user).

Usage

$bool = $tfa->startUser(User $user, array $settings);

Arguments

NameType(s)Description
userUser
settingsarray

Settings configured by user

Return value

bool

True on success, false on fail


Tfa 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