shop:password_restore CMS action
| Defined in |
/modules/shop/classes/shop_actions.php, lines 945-949 |
| Author |
LemonStand eCommerce Inc. |
Base action for the Password Restore page.
The action generates a new password for a customer with the specified email address, and sends an
email notification to the customer.
| Field |
Type |
Description |
| email |
string |
specifies the customer's email address. Required. |
| password_restore |
string |
optional SUBMIT input element name. |
| redirect |
string |
an optional field containing an URL for redirecting the browser after the successful password reset. |
| flash |
string |
an optional message to display after the redirection. |
Supported form field details
¶
email form field
Specifies the customer's email address. Required.
¶
password_restore form field
Optional SUBMIT input element name.
The submit button should have name password_restore if you are implementing a regular POST form.
Alternatively you can create an AJAX form with shop:on_passwordRestore handler.
¶
redirect form field
An optional field containing an URL for redirecting the browser after the successful password reset.
Use root_url() function if your copy of LemonStand is installed in a subdirectory.
¶
flash form field
An optional message to display after the redirection.
Use the flash_message() function the target page to display the message. Built-in AJAX handlers details
¶
shop:on_passwordRestore AJAX handler
Processes the password restore form.
Use this handler for creating a Submit link or button on the password restore page. Example:
<a href="#" onclick="return $(this).getForm().sendRequest('shop:on_passwordRestore')">Submit</a> |
