Tfa::processUserSettingsInputfields()

Called when the user config fieldset has been processed but before $settings have been saved

Usage

$array = $tfa->processUserSettingsInputfields(User $user, InputfieldWrapper $fieldset, array $settings, array $settingsPrev);

Arguments

NameType(s)Description
$userUser
$fieldsetInputfieldWrapper
$settingsarray

Associative array of new/current settings after processing

$settingsPrevarray

Associative array of previous settings

Return value

array

Return $newSettings array (modified as needed)


Hooking Tfa::processUserSettingsInputfields(…)

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

$this->addHookBefore('Tfa::processUserSettingsInputfields', 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);
  $settingsPrev = $event->arguments(3);

  /* 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);
  $event->arguments(3, $settingsPrev);
});

Hooking after

The 'after' hooks are called immediately after each Tfa::processUserSettingsInputfields(…) 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::processUserSettingsInputfields', 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);
  $settingsPrev = $event->arguments(3);

  /* 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.251