Tfa::getUserSettingsInputfields() method

Get fields needed for a user to configure and confirm TFA from their user profile

This method should be implemented by each TFA module. It is only used when the user has selected a TFA type and submitted form, but has not yet configured the TFA type.

Usage

$tfa->getUserSettingsInputfields(User $user, InputfieldWrapper $fieldset, array $settings);

Arguments

NameType(s)Description
userUser
fieldsetInputfieldWrapper
settingsarray

Hooking Tfa::getUserSettingsInputfields(…)

You can add your own hook events that are executed either before or after the Tfa::getUserSettingsInputfields(…) 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::getUserSettingsInputfields(…) method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

$this->addHookBefore('Tfa::getUserSettingsInputfields', 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)
  $user = $event->arguments(0);
  $fieldset = $event->arguments(1);
  $settings = $event->arguments(2);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $user);
  $event->arguments(1, $fieldset);
  $event->arguments(2, $settings);
});

Hooking after

The 'after' hooks are called immediately after each Tfa::getUserSettingsInputfields(…) 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::getUserSettingsInputfields', 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)
  $user = $event->arguments(0);
  $fieldset = $event->arguments(1);
  $settings = $event->arguments(2);

  /* 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 #547
    In the 547th issue of ProcessWire Weekly we're going to check out the latest core updates, introduce a couple of new modules, and more. Read on!
    Weekly.pw / 2 November 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 am currently managing a ProcessWire site with 2 million+ pages. It’s admirably fast, and much, much faster than any other CMS we tested.” —Nickie, Web developer