Jump to main content Jump to doc navigation

What is ChangePassword?

ChangePassword is a simple Snippet that is used in conjunction with Login, allowing users to change their password. You can place it anywhere, and it will process a form you must provide and change the user's password.


Simply create a Change Password form, and at the top of the page, put the snippet call. For example:

<h2>Change Password</h2>
<div class="updprof-error">[[!+cp.error_message]]</div>
<form class="form" action="[[~[[*id]]]]" method="post">
    <input type="hidden" name="nospam" value="" />
    <div class="ff">
        <label for="password_old">Old Password
            <span class="error">[[!+cp.error.password_old]]</span>
        <input type="password" name="password_old" id="password_old" value="[[+cp.password_old]]" />
    <div class="ff">
        <label for="password_new">New Password
            <span class="error">[[!+cp.error.password_new]]</span>
        <input type="password" name="password_new" id="password_new" value="[[+cp.password_new]]" />
    <div class="ff">
        <label for="password_new_confirm">Confirm New Password
            <span class="error">[[!+cp.error.password_new_confirm]]</span>
        <input type="password" name="password_new_confirm" id="password_new_confirm" value="[[+cp.password_new_confirm]]" />
    <div class="ff">
        <input type="submit" name="change-password" value="Change Password" />

ChangePassword Properties

ChangePassword comes with some default properties you can override. They are:

Name Description Default
submitVar The var to check for to load the ChangePassword functionality. If empty or set to false, ChangePassword will process the form on all POST requests. logcp-submit
fieldOldPassword The field name of the old password field. password_old
fieldNewPassword The field name of the new password field. password_new
fieldConfirmNewPassword Optional. If set, the field name of the confirm password field, and will be checked against the new password field during submission. password_new_confirm
validateOldPassword Set to 1 or 0. Define whether user is required to enter current password to successfully reset password. 1
preHooks What scripts to fire, if any, after the form passes validation but before save. This can be a comma-separated list of hooks, and if the first fails, the proceeding ones will not fire. A hook can also be a Snippet name that will execute that Snippet.
postHooks What scripts to fire, if any, after the user has been registered. This can be a comma-separated list of hooks, and if the first fails, the proceeding ones will not fire. A hook can also be a Snippet name that will execute that Snippet.
redirectToLogin If a user is not logged in and accesses this Resource, redirect them to the Unauthorized Page. 1
reloadOnSuccess If 1, the page will redirect to itself with a GET parameter to prevent double-postbacks. If 0, it will simply set a success placeholder. 1
successMessage If reloadOnSuccess is set to 0, output this message in the [prefix].successMessage placeholder.
placeholderPrefix The prefix to use for all placeholders set by this snippet. logcp.

See Also

  1. Login.Login
  2. Login.Profile
  3. Login.UpdateProfile
  4. Login.Register
    1. Register.Example Form 1
  5. Login.ConfirmRegister
  6. Login.ForgotPassword
  7. Login.ResetPassword
  8. Login.ChangePassword
  9. Login.Tutorials
    1. Login.Basic Setup
    2. Login.Extended User Profiles
    3. Login.Request Membership
    4. Login.User Profiles
    5. Login.Using Custom Fields
    6. Login.Using Pre and Post Hooks

Support the team building MODX with a monthly donation.

The budget raised through OpenCollective is transparent, including payouts, and any contributor can apply to be paid for their work on MODX.



$0 per month—let's make that $500!

Learn more