We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

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

Introduction

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

upcp


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

Returns

This event does not return output.

 

Backup


This event takes place when the system performs backups.

Available Stages:

  • pre — Hook action code runs before the system performs backups.
  • post — Hook action code runs after the system performs backups.

Note:

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

Action Code Runs As:

root

Blocking Attribute:

Escalate Privileges Attribute:

N/A

Returns

This event does not return output.