shop:change_password CMS action
Defined in |
/modules/shop/classes/shop_actions.php, lines 1002-1008 |
Author |
LemonStand eCommerce Inc. |
Base action for the Change Password page.
On this page a customer can change a password used for logging into the store. Note that the action requires a logged in customer,
so a page, the action is assigned to, must has the Customers Only security mode enabled.
The shop:on_changePassword AJAX handler allows to implement AJAX version of the page.
Field |
Type |
Description |
old_password |
string |
specifies the old customer's password. Required. |
password |
string |
specifies the new password. Required. |
password_confirm |
string |
specifies the password confirmation. Required. |
redirect |
string |
an optional field containing an URL for redirecting a visitor's browser after. |
flash |
string |
an optional message to display after the redirection. |
change_password |
string |
optional SUBMIT input element name. |
Variable |
Type |
Description |
customer |
Shop_Customer |
a customer object, representing a currently logged in customer. |
Supported form field details
¶
old_password form field
Specifies the old customer's password. Required.
¶
password form field
Specifies the new password. Required.
¶
password_confirm form field
Specifies the password confirmation. Required.
¶
redirect form field
An optional field containing an URL for redirecting a visitor's browser after
the successful password update. Note that you should use the 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.
¶
change_password form field
Optional SUBMIT input element name.
The submit button should have name change_password if you are implementing a regular POST form.
Alternatively you can create an AJAX form with shop:on_changePassword handler.
Generated PHP variable details
¶
customer variable
A customer object, representing a currently logged in customer.
|