Tfa::autoEnableSupported() method

Does this TFA module support automatic enable?

Automatic enable means a TFA module can be enabled for a user without their input. This can be supported by a module like TfaEmail when/if we already have the user’s email, but cannot be supported by a module like TfaTotp which requires manual setup by user.

Modules that support auto-enable must implement this method to return true. Modules that do not support it can ignore this method, as the default returns false.

Available since version 3.0.160.

Usage

// basic usage
$bool = $tfa->autoEnableSupported();

// usage with all arguments
$bool = $tfa->autoEnableSupported($user = null);

Arguments

NameType(s)Description
user (optional)User, null

Specify user to also confirm it is supported for given user. Omit to test if the module supports it in general.

Return value

bool


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

“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