Our documentation is getting an overhaul! We would like your input! Click here to take a look at the beta launch of our new documentation site! Only cPanel & WHM version 82 documentation exists on our beta at this time. 84 will be added to the new site soon! Leave your feedback here: https://go.cpanel.net/docsfeedback
The hook Script - Version 82 Documentation - cPanel Documentation
Page tree
For cPanel & WHM version 82.


Skip to end of metadata
Go to start of metadata

Overview 

The /usr/local/cpanel/scripts/hook script executes standardized hooks. Normally, only the system would execute these.

Run the script

To run this script on the command line, use the following format:

/usr/local/cpanel/scripts/hook [options]

Options

Note:

For more information about each event, read our Guide to Standardized Hooks - Hookable Events documentation.

The /usr/local/cpanel/scripts/hook script accepts the following options:

OptionDescriptionExample
--category

Required

The hook's category.

--category=System
--event

Required

The event that triggers the hook.

--event=upcp

--stage

Required

The stage of the event.

--stage=pre

Additional documentation