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.

Common
For hooks

Common

Name	Return	Summary
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() ProcessLogin::execute() ProcessLogin::execute()	`string`	Check if login posted and attempt login, otherwise render the login form
ProcessLogin::executeLogout() ProcessLogin::executeLogout() ProcessLogin::executeLogout()	`string`	Log the user out
ProcessLogin::getBeforeLoginVars() ProcessLogin::getBeforeLoginVars() ProcessLogin::getBeforeLoginVars()	`array`	Get validated/sanitized variables in the query string for not logged-in user to retain after login
ProcessLogin::getTfa() ProcessLogin::getTfa() ProcessLogin::getTfa()	`null` `Tfa`	Get Tfa instance or null if not applicable
ProcessLogin::getTfaConfigInputfields() ProcessLogin::getTfaConfigInputfields() ProcessLogin::getTfaConfigInputfields(array $data = [])	`InputfieldFieldset`	Get Inputfields to configure Tfa settings
ProcessLogin::labels() ProcessLogin::labels(string $name) ProcessLogin::labels(string $name, $value = null)	`string`	Get or set named label text
ProcessLogin::login() ProcessLogin::login(string $name, string $pass) ProcessLogin::login(string $name, string $pass)	`bool`	Perform login and redirect on success
ProcessLogin::markup() ProcessLogin::markup(string $name) ProcessLogin::markup(string $name, $value = null)	`string`	Get or set custom markup
ProcessLogin::setLoginURL() ProcessLogin::setLoginURL($url) ProcessLogin::setLoginURL($url)	`$this`	Set URL to redirect to after login success
ProcessLogin::setLogoutURL() ProcessLogin::setLogoutURL($url) ProcessLogin::setLogoutURL($url)	`$this`	Set 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() ProcessLogin::useEmailLogin() ProcessLogin::useEmailLogin()	`bool` `int`	Use login by email?

For hooks

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

Name	Return	Summary
ProcessLogin::afterLogin() ProcessLogin::afterLogin() ProcessLogin::afterLogin()	(nothing)
ProcessLogin::afterLoginOutput() ProcessLogin::afterLoginOutput() ProcessLogin::afterLoginOutput()	`string`
ProcessLogin::afterLoginRedirect() ProcessLogin::afterLoginRedirect() ProcessLogin::afterLoginRedirect($url = '')	(nothing)
ProcessLogin::afterLoginURL() ProcessLogin::afterLoginURL() ProcessLogin::afterLoginURL($url = '')	`string`
ProcessLogin::beforeLogin() ProcessLogin::beforeLogin() ProcessLogin::beforeLogin()	(nothing)
ProcessLogin::buildLoginForm() ProcessLogin::buildLoginForm() ProcessLogin::buildLoginForm()	`InputfieldForm`
ProcessLogin::executeLoggedOut() ProcessLogin::executeLoggedOut() ProcessLogin::executeLoggedOut()	`string`
ProcessLogin::getLoginLinks() ProcessLogin::getLoginLinks() ProcessLogin::getLoginLinks()	`array`	Get array of links to display under login form
ProcessLogin::loginAttemptReady() ProcessLogin::loginAttemptReady(string $name) ProcessLogin::loginAttemptReady(string $name)	(nothing)	Hook called right before a login is attempted
ProcessLogin::loginAttempted() ProcessLogin::loginAttempted($user, string $name) ProcessLogin::loginAttempted($user, string $name)	(nothing)	Hook called immediately after a login was attempted
ProcessLogin::loginFailed() ProcessLogin::loginFailed($name) ProcessLogin::loginFailed($name, $message = '')	(nothing)
ProcessLogin::loginFormProcessReady() ProcessLogin::loginFormProcessReady(InputfieldForm $form) ProcessLogin::loginFormProcessReady(InputfieldForm $form)	(nothing)	Hook called immediately before the login form in processed
ProcessLogin::loginFormProcessed() ProcessLogin::loginFormProcessed(InputfieldForm $form, string $name) ProcessLogin::loginFormProcessed(InputfieldForm $form, string $name)	(nothing)	Hook called immediately after login form processed and user name/pass identified as present
ProcessLogin::loginSuccess() ProcessLogin::loginSuccess(User $user) ProcessLogin::loginSuccess(User $user)	(nothing)
ProcessLogin::renderLoginForm() ProcessLogin::renderLoginForm() ProcessLogin::renderLoginForm()	`string`
ProcessLogin::renderLoginLinks() ProcessLogin::renderLoginLinks() 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.236

Login to ProcessWire

Common

For hooks

Additional methods and properties

Newest forum posts

Latest news

Subscribe to weekly ProcessWire news