Child pages
  • Guide to Standardized Hooks - System Functions

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Introduction

Excerpt

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

upcp


Section
Column
width50%
Panel
bgColor#FFFFFF
borderStylenone

This event takes place when cPanel & WHM updates.

Available Stages:

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

    Warning
    titleImportant
    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.
Column
bgColor#FFFFFF
width50%
borderStylenone
Panel
bgColor#F2F2F2
borderStylenone
Panel
bgColor#FFFFFF
borderStylenone
Section
Column
width40%

Action Code Runs As:

Column

root

Section
Column
width40%

Blocking Attribute:

Column

Section
Column
width40%

Escalate Privileges Attribute:

Column

N/A

Output parameters

This event does not return output.

 

Backup


Section
Column
width50%
Panel
bgColor#FFFFFF
borderStylenone

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
titleNote:

Hooks for this event do not trigger when the Legacy Backup System runs.

Column
bgColor#FFFFFF
width50%
borderStylenone
Panel
bgColor#F2F2F2
borderStylenone
Panel
bgColor#FFFFFF
borderStylenone
Section
Column
width40%

Action Code Runs As:

Column

root

Section
Column
width40%

Blocking Attribute:

Column

Section
Column
width40%

Escalate Privileges Attribute:

Column

N/A

Output parameters

This event does not return output.