Function __global->lost_password_emailer_step
Definitions
sources/cns_lost_password.php
- Logic and flow for sending out a lost password e-mail.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: array
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $username | string | No | No | required parameter | N/A | N/A | Username to reset for (may be blank if other is not) |
| No | No | required parameter | N/A | N/A | E-mail address to set for (may be blank if other is not) |
Returns
- A tuple: e-mail address (may be blank), member ID (may be null if no member existed but we're not revealing such)
- Type: array
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Logic and flow for sending out a lost password e-mail.
*
* @param string $username Username to reset for (may be blank if other is not)
* @param EMAIL $email E-mail address to set for (may be blank if other is not)
* @return array A tuple: e-mail address (may be blank), member ID (may be null if no member existed but we're not revealing such)
*/
function lost_password_emailer_step(string $username, string $email) : array
* Logic and flow for sending out a lost password e-mail.
*
* @param string $username Username to reset for (may be blank if other is not)
* @param EMAIL $email E-mail address to set for (may be blank if other is not)
* @return array A tuple: e-mail address (may be blank), member ID (may be null if no member existed but we're not revealing such)
*/
function lost_password_emailer_step(string $username, string $email) : array
