Tfa::start() method

Start 2-factor authentication

On successful authentication of user, this method performs a redirect to the next step. If user does not exist, they are not allowed to login, or fails to authenticate, this method returns a boolean false. If user does not have 2FA enabled, or is remembered from a previous TFA login, then this method returns true, but user still needs to be authenticated.

If preferred, you can ignore the return value, as this method will perform redirects whenever it needs to move on to the next 2FA step.

Usage

$bool = $tfa->start(string $name, string $pass);

Arguments

NameType(s)Description
namestring
passstring

Return value

bool


Hooking Tfa::start(…)

You can add your own hook events that are executed either before or after the Tfa::start(…) method is executed. Examples of both are included below. A good place for hook code such as this is in your /site/ready.php file.

Hooking before

The 'before' hooks are called immediately before each Tfa::start(…) method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

$this->addHookBefore('Tfa::start', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $Tfa = $event->object;

  // Get values of arguments sent to hook (and optionally modify them)
  $name = $event->arguments(0);
  $pass = $event->arguments(1);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $name);
  $event->arguments(1, $pass);
});

Hooking after

The 'after' hooks are called immediately after each Tfa::start(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('Tfa::start', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $Tfa = $event->object;

  // An 'after' hook can retrieve and/or modify the return value
  $return = $event->return;

  // Get values of arguments sent to hook (if needed)
  $name = $event->arguments(0);
  $pass = $event->arguments(1);

  /* Your code here, perhaps modifying the return value */

  // Populate back return value, if you have modified it
  $event->return = $return;
});

Tfa methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #515
    In the 515th issue of ProcessWire Weekly we’ll check out the latest core updates, new modules, and more. Read on!
    Weekly.pw / 23 March 2024
  • Invoices Site Profile
    The new invoices site profile is a free invoicing application developed in ProcessWire. It enables you to create invoices, record payments to them, email invoices to clients, print invoices, and more. This post covers all the details.
    Blog / 15 March 2024
  • Subscribe to weekly ProcessWire news

“We chose ProcessWire because of its excellent architecture, modular extensibility and the internal API. The CMS offers the necessary flexibility and performance for such a complex website like superbude.de. ProcessWire offers options that are only available for larger systems, such as Drupal, and allows a much slimmer development process.” —xport communication GmbH