ProcessLogin class

Login to ProcessWire

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the ProcessLogin class also inherits all the methods and properties of: Process, WireData and Wire.

Show class?             Show args?        

Common

NameReturnSummary 
ProcessLogin::allowEmail bool int Whether or not email login is allowed (0|false=off, 1|true=Yes, 2=Yes or name also allowed) 
ProcessLogin::allowForgot bool Whether the ProcessForgotPassword module is installed. 
ProcessLogin::emailField string Field name used for email login (when enabled).  
ProcessLogin::execute()
stringCheck if login posted and attempt login, otherwise render the login form
ProcessLogin::executeLogout()
stringLog the user out
ProcessLogin::getBeforeLoginVars()
arrayGet validated/sanitized variables in the query string for not logged-in user to retain after login
ProcessLogin::getTfa()
null TfaGet Tfa instance or null if not applicable 
ProcessLogin::getTfaConfigInputfields()
InputfieldFieldsetGet Inputfields to configure Tfa settings 
ProcessLogin::labels(string $name)
stringGet or set named label text 
ProcessLogin::login(string $name, string $pass)
boolPerform login and redirect on success
ProcessLogin::markup(string $name)
stringGet or set custom markup 
ProcessLogin::setLoginURL($url)
$thisSet URL to redirect to after login success 
ProcessLogin::setLogoutURL($url)
$thisSet URL to redirect to after logout success 
ProcessLogin::tfaAutoRoleIDs array Auto-enable for these role IDs, or blank for all roles. Applies only if $tfaAutoType selected (default=[]) 
ProcessLogin::tfaAutoType string Auto-enable type, aka module name (default='') 
ProcessLogin::tfaRecRoleIDs array Role IDs where admin prompts/recommends them to enable TFA. 
ProcessLogin::tfaRememberDays int Allow user to remember their browser and bypass TFA for this many days (-1=no limit, 0=disabled) 
ProcessLogin::tfaRememberFingerprints array Means by which to fingerprint user’s browser 
ProcessLogin::useEmailLogin()
bool intUse login by email? 

For hooks

These methods are only useful for hooking and should not be called directly.

NameReturnSummary 
ProcessLogin::afterLogin()
(nothing)
ProcessLogin::afterLoginOutput()
string
ProcessLogin::afterLoginRedirect()
(nothing)
ProcessLogin::afterLoginURL()
string
ProcessLogin::beforeLogin()
(nothing)
ProcessLogin::buildLoginForm()
InputfieldForm
ProcessLogin::executeLoggedOut()
string
ProcessLogin::getLoginLinks()
arrayGet array of links to display under login form
ProcessLogin::loginFailed($name)
(nothing)
ProcessLogin::loginSuccess(User $user)
(nothing)
ProcessLogin::renderLoginForm()
string
ProcessLogin::renderLoginLinks()
string

Additional methods and properties

In addition to the methods and properties above, ProcessLogin also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.209

Twitter updates

  • Adding custom actions to ProcessWire image fields in the admin, part of this week’s dev branch additions: More
    27 January 2023
  • ProcessWire 3.0.210 new main/master version released— More
    6 January 2023
  • ProcessWire 3.0.209: Core updates and an interesting AI that knows ProcessWire– More
    30 December 2022

Latest news

  • ProcessWire Weekly #456
    The 456th issue of ProcessWire Weekly covers latest core updates, introduces a new third party module called TextformatterRockDown, and more. Read on!
    Weekly.pw / 4 February 2023
  • ProcessWire 3.0.210 new main/master version
    140 commits, 55 resolved issues, dozens of new features, eight contributors, and five new pull requests make yet another great new version of ProcessWire.
    Blog / 6 January 2023
  • Subscribe to weekly ProcessWire news

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK