The hook Script

Valid for versions 82 through the latest version

Version:

82


Last modified: May 13, 2020

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:

Option Description Example
--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