Introduction
The Passwd
category's events occur when a WHM user changes a cPanel user's password. These events trigger during the use of WHM's Password Modification interface (Home >> Account Functions >> Password Modification), WHM API 0's passwd
function, or WHM API 1's passwd
function.
Important:
These events do not trigger during the use of cPanel'sChange Password interface (Home >> Preferences >> Change Password) or cPanel API 2'sPasswd::change_password
function.
ChangePasswd
This event takes place when a user's password changes.
Available Stages:
pre
— Hook action code runs before the password changes.-
post
— Hook action code runs after the password changes.
Action Code Runs As:
- During transfers, the
root
user. - While the system generates backup files, the user who owns the backup.
Blocking Attribute:
Escalate Privileges Attribute:
Output parameters
Note:
The chosen stage determines the event's output. Select the appropriate tab to view output parameters for that stage.
Pre
Parameter |
Type |
Description |
Possible values |
Example |
user |
string |
The user for whom the password will change. |
A valid username on the server. |
username |
new_password |
string |
The user's new password. |
A secure password. |
12345luggage |
Parameter |
Type |
Description |
Possible values |
Example |
user |
string |
The user for whom the password will change. |
A valid username on the server. |
username |
new_password |
string |
The user's new password. |
A secure password. |
12345luggage |
rawout |
string |
The event's raw output. |
A string value. |
This is raw output. |
applist |
string |
A list of applications for which the password changed. |
A list of one or more application names. |
application1,application2 |