ProcessForgotPassword class

Provides password reset capability for when users forget their password.

This accompanies the ProcessLogin module.

For more details about how Process modules work, please see: wire/core/Process.php

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

Common

Name	Return	Summary
ProcessForgotPassword::clearRequests() ProcessForgotPassword::clearRequests() ProcessForgotPassword::clearRequests()	None	Clear all password reset requests
ProcessForgotPassword::error() ProcessForgotPassword::error($text) ProcessForgotPassword::error($text, int $flags = 0)	`Wire`	Record error
ProcessForgotPassword::execute() ProcessForgotPassword::execute() ProcessForgotPassword::execute()	None	Check if login posted and attempt login, otherwise render the login form
ProcessForgotPassword::log() ProcessForgotPassword::log() ProcessForgotPassword::log(string $str = '', array $options = [])	`WireLog`	Log a message for this class
ProcessForgotPassword::upgrade() ProcessForgotPassword::upgrade($fromVersion, $toVersion) ProcessForgotPassword::upgrade($fromVersion, $toVersion)	None
ProcessForgotPassword::wired() ProcessForgotPassword::wired() ProcessForgotPassword::wired()	None	Wired to API

For hooks

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

Name	Return	Summary
ProcessForgotPassword::renderEmailBody() ProcessForgotPassword::renderEmailBody(string $url, string $code) ProcessForgotPassword::renderEmailBody(string $url, string $code, bool $html = false)	`string`	Render the password reset email body
ProcessForgotPassword::renderErrorEmailBody() ProcessForgotPassword::renderErrorEmailBody(string $error) ProcessForgotPassword::renderErrorEmailBody(string $error)	`string`	Render the error email body

Properties

Name	Return	Summary
ProcessForgotPassword::allowReset	`bool` `int`	Allow passwords to be reset?
ProcessForgotPassword::allowRoles	`array`	Only allow password reset for these roles, optional. DEFAULT: []
ProcessForgotPassword::askEmail	`bool` `int`	Ask user for their email address rather than username? DEFAULT: false
ProcessForgotPassword::beHonest	`bool` `int`	Be honest about whether account exists or not? More helpful but less secure when true. DEFAULT: false
ProcessForgotPassword::blockRoles	`array`	Block these roles, optional. DEFAULT: []
ProcessForgotPassword::confirmFields	`array`	Extra field values to confirm values before accepting password change, optional. DEFAULT: ['email']
ProcessForgotPassword::emailFrom	`string`	Send emails from this address
ProcessForgotPassword::emailSubject	`string`	Subject line for email that is sent DEFAULT: 'Password Reset Information'
ProcessForgotPassword::expireSecs	`int`	Seconds after which requests expire. DEFAULT: 3600
ProcessForgotPassword::maxPerIP	`int`	Max concurrent reset requests per IP address per hour or session. DEFAULT: 3
ProcessForgotPassword::table	`string`	DB table
ProcessForgotPassword::useInlineNotices	`bool` `int`	Render errors inline (rather than as notices)? DEFAULT: false
ProcessForgotPassword::useLog	`bool` `int`	Log activity? DEFAULT: true
ProcessForgotPassword::wireMailer	`string`	WireMail module name to use or omit for system default. 3.0.148.

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.251