Skip to content
Last updated

Development Guides Home >> Guide to Standardized Hooks >> Hookable Events

Guide to Standardized Hooks - DiskQuota Functions

The DiskQuota category's events occur during disk quota processing.

critical

This event triggers whenever a cPanel account approaches its disk quota.

Information

  • Action code runs as: root
  • Blocking attribute: Unavailable.
  • Escalate privileges attribute: N/A

Available stages

  • pre - The hook's action code runs when an account's disk usage reaches critical status.

pre returns

ReturnTypeDescriptionPossible valuesExample
blocks_limitintegerThe cPanel account's disk quota, measured in bytes.A positive integer.1000000
blocks_usedintegerThe cPanel account's amount of disk space used, measured in bytes.A positive integer.999999
contact_infohashA hash that contains information about the cPanel account's contact settings.
cpuserhashA hash that contains information about the cPanel user account.
inodes_usedintegerThe cPanel account's amount of inodes used.A positive integer.12345678
inodes_limitintegerThe cPanel account's inodes quota.A positive integer.123456789

fail

This event triggers whenever a cPanel account exceeds its disk quota.

Information

  • Action code runs as: root
  • Blocking attribute: Unavailable.
  • Escalate privileges attribute: N/A

Available stages

  • pre - The hook's action code runs when an account exceeds its disk quota.

pre returns

ReturnTypeDescriptionPossible valuesExample
blocks_limitintegerThe cPanel account's disk quota, measured in bytes.A positive integer.1000000
blocks_usedintegerThe cPanel account's amount of disk space used, measured in bytes.A positive integer.999999
contact_infohashA hash that contains information about the cPanel account's contact settings.
cpuserhashA hash that contains information about the cPanel user account.
inodes_usedintegerThe cPanel account's amount of inodes used.A positive integer.12345678
inodes_limitintegerThe cPanel account's inodes quota.A positive integer.123456789

warn

Information

  • Action code runs as: root
  • Blocking attribute: Unavailable.
  • Escalate privileges attribute: N/A

Available stages

  • pre - The hook's action code runs when an account's disk usage reaches warn status.

pre returns

ReturnTypeDescriptionPossible valuesExample
blocks_limitintegerThe cPanel account's disk quota, measured in bytes.A positive integer.1000000
blocks_usedintegerThe cPanel account's amount of disk space used, measured in bytes.A positive integer.999999
contact_infohashA hash that contains information about the cPanel account's contact settings.
cpuserhashA hash that contains information about the cPanel user account.
inodes_usedintegerThe cPanel account's amount of inodes used.A positive integer.12345678
inodes_limitintegerThe cPanel account's inodes quota.A positive integer.123456789