Child pages
  • Guide to Standardized Hooks - Passwd Functions
Skip to end of metadata
Go to start of metadata

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 (WHM >> 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's Password & Security interface (cPanel >> Home >> Preferences >> Password & Security) or cPanel API 2's Passwd::change_password function.

Note:

In cPanel & WHM version 54 and earlier, cPanel's Password & Security interface interface was the Change Password interface. 

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:

Returns

Note:

The chosen stage determines the event's returns. Select the appropriate tab to view return for that stage. 

ParameterTypeDescriptionPossible 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.12345luggage
ParameterTypeDescriptionPossible 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.12345luggage
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