Hooks:Clients

• Documentation Home
• General Information
  • System Requirements
  • Installing WHMCS
  • Upgrading
  • Release Notes
  • Further Security Steps
  • Importing Data
  • Licensing
  • Common Troubleshooting Tips
• Key Aspects
  • Clients
  • Orders
  • Products
  • Domains
  • Invoicing
  • Transactions
  • Support Tickets
  • Messages & Emails
• Setup/Configuration
  • General Settings
  • Automation Settings
  • Payment Gateways
  • Admins/Permissions
  • Products/Services
  • Support Departments
• Developer Resources
  • Client Area Templates
  • Order Form Templates
  • Language Files
  • Action Hooks
  • Widgets
  • Creating Modules
  • API

Client Hooks

ClientAdd

This hook is run when adding a new client. It doesn't matter how the client is added - can be via the admin area, client side signup or API - the hook will always be called.

Variables

• userid
• firstname
• lastname
• companyname
• email
• address1
• address2
• city
• state
• postcode
• country
• phonenumber
• password

ClientAreaRegister

This hook is used when the client uses the register.php link to create a client account.

Variables

• userid

ClientEdit

This hook is used when editing a client. This hook is run whether the client is being edited through the Admin area or altering their details through the Client Area

Variables

• userid
• firstname
• lastname
• etc... (containing new details),
• olddata (an array of previous values)

ClientLogin

This hook is run when the client logs in to the Client Area, or an Admin user uses the "Login as Client" function from the Client Summary page.

Variables

• userid

ClientLogout

This is run whenever the Logout link is clicked from the Client Area

Variables

• userid

ClientChangePassword

This hook is run when the client password is changed. This can be through the Admin area, Client Area, or through the pwreset.php functions

Variables

• userid
• password

ClientDetailsValidation

This is run when before adding a client or updating a client through the Admin or Client area. Return the error as a string, or array for multiple errors, for the validation routine to obtain the errors and display them on the submitted form.

Variables

• $_POST

ClientClose

This is run when clicking the Close Client link on the Client Summary page in the Admin area

Variables

• userid

ClientDelete

This is run when clicking the Delete Client link on the Client Summary page in the Admin area

Variables

• userid

PreDeleteClient

This is run when clicking the Delete Client link on the Client Summary page in the Admin area, but before the client is removed.

Variables

• userid