Software Development Kit
cPanel & WHM's API [+] cPanel & WHM's API [-]Basics
Introduction Authenticating API Function Calls cPanel Template Toolkit Internal API
Calling Unified API (UAPI) Functions Calling API 1 Functions Calling API 2 Functions API 1 & 2 Functions via XML API UAPI Functions API 1 Functions API 2 Functions External API
XML and JSON API Parsing XML Data Manage 2 API API Privilege Escalation
Modules and Plugins [+] Modules and Plugins [-]
cPanel Modules
Writing cPanel Modules PHP Accounting Module cPanel::Accounting Perl Module Writing cPanel Plugins
Writing cPanel Plugins PHP in cPanel Plugin Interfaces cPanel CGI Scripts Live PHP in cPanel Plugins Plugin Variables Installing cPanel Plugins Adding Icons and Groups ExpVar Reference (ExpVarRef) Plugin Installation File Generator Plugin Security Policy (
.pdf)
WHM Plugins
Creating WHM Plugins ACL Reference Table The swapip Utility cPanel Logger Module Pluggable dnsadmin Modules EasyApache Modules
Custom Modules
cPanel & WHM Hooks [+] cPanel & WHM Hooks [-]
Standardized Hooks Introduction Taxonomy Getting Started Hooks Management Interface Hookable Events Advanced Usage Troubleshooting
Legacy Hooks Introduction Writing Function Hooks Script Hooks Custom Event Handlers cPanel Logger Module Universal Password Trap Hooking into EasyApache
EasyApache Hooks
cPAddons (Site Software) [+] cPAddons (Site Software) [-]
System Administration [+] System Administration [-]
Developer Software [+] Developer Software [-]
Back to All Documentation
Stats Functions
Stats::RunAll
Stage:pre — This hookable event is run before all cPanel stats are run.
Blocking Attribute: No
Escalate Privilege Attribute: N/A
Action Code Runs As: root
Data: None
Stage: post — This hookable event is run after all cPanel stats are run.
Blocking Attribute: No
Escalate Privilege Attribute: N/A
Action Code Runs As: root
Data: None
Stats::RunUser
Stage:pre — This hookable event is run before an individual user's statistics are processed by cpanellogd.
Blocking Attribute: No
Escalate Privilege Attribute: No
Action Code Runs As: The cPanel user whose stats are being processed.
Data:
{
'lastruntime' => "The Unix timestamp that indicates the last time stats were run for the user.",
'user' => "The user whose stats are being processed by the system.",
'homedir' => "The user's home directory.",
'rLOG_CONF' => "A hash reference that indicates which analytics programs will process each of the user's domains.",
'maindomain' => "The user's main domain.",
'rALLDOMAINS' => "An array reference that contains all of the cPanel user's domains.",
'logfiledesc' => # An array of hash references that contain an entry for each domain processed by cpanellogd.
[
{
'domain' => "The domain being processed.",
'filename' => "The log file's filename.",
'logfile' => "The location of the log file being processed."
},
],
}
Stage:
post — This hookable event is run after an individual user's statistics are processed by cpanellogd.
Blocking Attribute: No
Escalate Privilege Attribute: No
Action Code Runs As: The cPanel user whose stats were processed.
Data:
{
'lastruntime' => "The Unix timestamp that indicates the last time stats were run for the user.",
'user' => "The user whose stats are being processed by the system.",
'homedir' => "The user's home directory.",
'rLOG_CONF' => "A hash reference that indicates which analytics programs will process each of the user's domains.",
'maindomain' => "The user's main domain.",
'rALLDOMAINS' => "An array reference that contains all of the cPanel user's domains.",
'logfiledesc' => # An array of hash references that contain an entry for each domain processed by cpanellogd.
[
{
'domain' => "The domain being processed.",
'filename' => "The log file's filename.",
'logfile' => "The location of the log file being processed."
},
],
}
Topic revision: r4 - 29 Nov 2012 - 14:14:56 - Main.ColinShannon
SoftwareDevelopmentKit.StdStatsFunctions moved from Sandbox.StdStatsFunctions on 12 Mar 2012 - 20:46 by Main.JustinSchaefer - put it back