Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
| Include Page | ||||
|---|---|---|---|---|
|
Introduction
| Excerpt |
|---|
| Standardized Hooks trigger applications when cPanel & WHM performs an action. |
| Note | ||
|---|---|---|
| ||
For a step-by-step tutorial to create and register a hook, read our Tutorial - Create a Standardized Hook documentation. |
Basic usage
Each standardized hook is comprised of a hookable event, a hook action, and hook registration.
To create a new standardized hook, perform the following steps:
Select a hookable event. —
Excerpt Include Guide to Standardized Hooks - Hookable Events Guide to Standardized Hooks - Hookable Events nopanel true - Write your custom hook action code.
- Register the hook. —
Excerpt Include Guide to Standardized Hooks - The manage_hooks Utility Guide to Standardized Hooks - The manage_hooks Utility nopanel true - The system includes a hooks registry for each hookable event. This allows hooks from your application to coexist with another application's hooks that reference the same event.
cPanel & WHM provides a CLI utility to manage standardized hooks.
The Standardized Hook System database
Standardized Hooks System data resides in the /var/cpanel/hooks.yaml file. This database is the authoritative reference for all standardized hook data. The Standardized Hooks System also maintains a cached copy of this database in the /var/cpanel/hooks.cache file. The cache file regenerates automatically whenever you query the Standardized Hooks System is queried internally or through a management utility.
| Warning | ||
|---|---|---|
| ||
Do not edit this file by hand. Instead, manage Standardized Hooks with the |
| Tip | ||
|---|---|---|
| ||
If you have questions or need help with your customization project, join the conversation on our cPanel Developers Forum, or send an email to integration@cpanel.net. We encourage anyone who develops for cPanel products to read the cPanel Blog and join our Plugin Developers mailing list. |
| Include Page | ||||
|---|---|---|---|---|
|
| HideElements | ||
|---|---|---|
|