Documentation

all.php

Table of Contents

Functions

HookTotpAllPreheaderoutput()  : void
Redirects the user to the TOTP setup page if their TOTP cookie is invalid or missing.
HookTotpAllAdditionalheaderjs()  : void
Includes the QR code JavaScript library needed for TOTP setup.
HookTotpTeam_user_editAdditionaluserfields()  : void
Adds a TOTP reset checkbox to the user edit form.
HookTotpTeam_user_editAdditionaluserfieldssave()  : PreparedStatementQuery|null
Processes the TOTP reset checkbox and prepares a query to reset the user's TOTP data.
HookTotpAllBeforetermsredirect()  : mixed

Functions

HookTotpAllPreheaderoutput()

Redirects the user to the TOTP setup page if their TOTP cookie is invalid or missing.

HookTotpAllPreheaderoutput() : void

This hook runs before the page header output and ensures that users with TOTP enabled are redirected to complete setup or authentication if needed.

HookTotpAllAdditionalheaderjs()

Includes the QR code JavaScript library needed for TOTP setup.

HookTotpAllAdditionalheaderjs() : void

This hook appends the necessary JS to the page header.

HookTotpTeam_user_editAdditionaluserfields()

Adds a TOTP reset checkbox to the user edit form.

HookTotpTeam_user_editAdditionaluserfields() : void

This allows administrators to reset a user's TOTP configuration, e.g. if they have lost their device.

HookTotpTeam_user_editAdditionaluserfieldssave()

Processes the TOTP reset checkbox and prepares a query to reset the user's TOTP data.

HookTotpTeam_user_editAdditionaluserfieldssave() : PreparedStatementQuery|null

If the reset checkbox was ticked, returns a PreparedStatementQuery that modifies the user save action to clear the user's TOTP fields.

Return values
PreparedStatementQuery|null

A query to reset TOTP fields, or null if not resetting.

HookTotpAllBeforetermsredirect()

HookTotpAllBeforetermsredirect() : mixed
On this page

Search results