Guide to Standardized Hooks - System Functions

Introduction

The System category's events occur during system updates or backups.

This event takes place when cPanel & WHM updates.

Available Stages:

pre — Hook action code runs before the update process.
Important

Unlike other pre stages, the success or failure of this event's hook action code cannot block execution of the cPanel & WHM event. The Standardized Hooks System cannot affect the cPanel & WHM update process.
post — Hook action code runs after the update process.

Action Code Runs As:

root

Blocking Attribute:

Escalate Privileges Attribute:

N/A

This event does not return output.

This event takes place when the system performs backups.

Available Stages:

Note:

Hooks for this event do not trigger the legacy backup system.

Action Code Runs As:

root

Blocking Attribute:

Escalate Privileges Attribute:

N/A

This event does not return output.

About Standardized Hooks

The Standardized Hooks system triggers scripts or applications whenever a specific action is performed in cPanel & WHM.
This functionality is useful for developers and system administrators.

Compatible with:

Page:

Guide to Standardized Hooks - Checks — Checks verify arbitrary conditions before the system runs the hook action code.
Page:

Guide to Standardized Hooks - Exceptions — The Standardized Hooks System honors exceptions in hook action code or in check actions.
Page:

Guide to Standardized Hooks - Custom Event Handlers — Custom event handlers run before or after cPanel API functions.
Page:

Guide to Standardized Hooks - Function Hooks — Function hook scripts run automatically, after a specific cPanel API function.
Page:

WHM API 1 Sections - Script Hooks — Script Hook functions allow you to manage a server's script hooks.