Skip to content
Last updated

Development Guides Home >> Guide to Standardized Hooks >> Hookable Events

Guide to Standardized Hooks - Passwd Functions

The Passwd category's events occur when a WHM user or a cPanel user changes a cPanel user's password. These events trigger during the use of the following interfaces:

These events also trigger during the use of the following API functions:

ChangePasswd

This event takes place when a user's password changes.

Information

  • Action code runs as: root
  • Blocking attribute: Available.
  • Escalate privileges attribute: Unavailable.

Available stages

  • pre — Hook action code runs before the password changes.
  • post — Hook action code runs after the password changes.

pre returns

ReturnTypeDescriptionPossible valuesExample
userstringThe user for whom the password will change.A valid username on the server.username
new_passwordstringThe user's new password.A secure password.123456luggage

post returns

ReturnTypeDescriptionPossible valuesExample
userstringThe user for whom the password changed.A valid username on the server.username
new_passwordstringThe user's new password.A secure password.123456luggage
rawoutstringThe event's raw output.A string value.This is raw output.
appliststringA list of applications for which the password changed.A list of one or more application names.application1,application2