Tfa::autoEnableUser()

Auto-enable this TFA module for given $user

Automatic enable means a TFA module can be enabled for a user without their input.

This method throws WireException for all error conditions, so you may want to call the autoEnableSupported($user) method first.

Available since version 3.0.160.

Usage

// basic usage
$tfa->autoEnableUser(User $user);

// usage with all arguments
$tfa->autoEnableUser(User $user, array $settings = []);

Arguments

NameType(s)Description
$userUser

User to auto-enable this Tfa module for.

$settings (optional)array

This argument can be omitted in public API usage, but should be specified by Tfa modules in parent::autoEnableForUser() call, containing any needed settings.

Exceptions

Method can throw exceptions on error:

  • WireException - on all error conditions

Tfa methods and properties

API reference based on ProcessWire core version 3.0.252