Software Development Kit
cPanel & WHM's API [+] cPanel & WHM's API [-]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 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
cPAddons Module Documentation
Allows users to install 3rd party applications to their document root The functions within this module may or may not be governed by a feature list. The required feature list may vary from function to function, to review a total list of the available features sets on a cPanel server, please see "Feature Manager" in WHM.cPAddons::mainpg
| API Version: | 1 - Click here for documentation |
|---|---|
| Syntax: | cPAddons::mainpg( ) |
| Description: | This function can: 1. Retrieve a list of cPAddons available for install. 2. Display the particular cPAddon creation interface once one is selected. 3. Install a cPAddon. 4. Change the account's cPAddon notification status. If this function is called without any arguments, the first option above is taken. |
| Form Data: | |
| action (string) | |
| Setting this parameter to 'notify' checks the 'on' parameter and sets the appropriate notification status. Setting this parameter to 'install' causes the function to install a particular cPAddon. In this case, the function will require the parameters needed by the application. Please remember that the needs of applications may vary. A typical set of extra parameters could resemble the following: $VAR1 = { 'addon' => 'cPanel::CMS::Xoops', 'action' => 'install', 'auser' => 'adminuser', 'apass' => 'adminpass', 'apass2' => 'adminpass', 'email' => 'test@example.com', 'subdomain' => '', 'installdir' => 'xoops', 'admin_display' => 'admindisplayname', 'use_persistent' => 0, 'table_prefix' => 'xoops', 'existing_mysql' => '' }; Each cPAddon has its own requirements. The 'addon' parameter can generate the necessary { action => install } parameters. |
|
| addon (string) | |
| If this argument is supplied, the function will display the configuration GUI for the addon. The argument will refer to the cPAddon name as the cPAddon namespace (e.g. 'cPanel::CMS::Geeklog'). A full list of available names resides in /usr/local/cpanel/cpaddons/cPAddonsAvailable.pm. | |
| asuser (string) | |
| The administrative user for the cPAddon. | |
| on (boolean) | |
| Specifying 1 to this parameter enables notifications if the 'action' parameter is set to 'notify'. | |
| Returns: | |
The output of this function will vary dramatically, depending on the input.
|
Edit | Attach | Print version | History: r2 < r1 | Backlinks | Raw View | More topic actions
Topic revision: r2 - 27 Mar 2012 - 17:43:28 - Main.JenniferDoubrava