cPanel API 2 Modules - Branding
Warning:
The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.
Introduction
The Branding module accesses cPanel's theming system.
Available functions
-
cPanel API 2 Functions -
Branding::addbrandingobj— This function adds an item to the currentdynamicui.conffile. -
cPanel API 2 Functions -
Branding::applist— This function lists icon information from the currentdynamicui.conffile. -
cPanel API 2 Functions -
Branding::brandingeditor— This function updates objects in a branding package'sdynamicui.conffile. -
cPanel API 2 Functions -
Branding::createpkg— This function creates a branding package's directory. -
cPanel API 2 Functions -
Branding::cssmerge— This function updates a branding package's CSS file. -
cPanel API 2 Functions -
Branding::delbrandingobj— This function deletes items from the currentdynamicui.conffile. -
cPanel API 2 Functions -
Branding::delpkg— This function deletes a branding package. -
cPanel API 2 Functions -
Branding::gensprites— This function rebuilds the cPanel interface's sprites. -
cPanel API 2 Functions -
Branding::getbrandingpkg— This function retrieves the current branding package's name. -
cPanel API 2 Functions -
Branding::getbrandingpkgstatus— This function retrieves the current branding package's status. -
cPanel API 2 Functions -
Branding::getdefaultbrandingpkg— This function retrieves the account's default branding package. -
cPanel API 2 Functions -
Branding::installbrandingpkgs— This function is for cPanel & WHM's internal use only. -
cPanel API 2 Functions -
Branding::installimages— This function checks whether the current branding package's images are installed. -
cPanel API 2 Functions -
Branding::killimgs— This function is for cPanel & WHM's internal use only. -
cPanel API 2 Functions -
Branding::listimgtypes— This function lists the currentdynamicui.conffile's image types. -
cPanel API 2 Functions -
Branding::listobjecttypes— This function lists the currentdynamicui.conffile's object types. -
cPanel API 2 Functions -
Branding::preloadconf— This function returns thedynamicui.conffile's contents. -
cPanel API 2 Functions -
Branding::resetall— This function resets all of thedynamicui.conffile's items. -
cPanel API 2 Functions -
Branding::resetcss— This function resets thelocal.cssfile. -
cPanel API 2 Functions -
Branding::resethtml— This function resets the branding package's HTML files. -
cPanel API 2 Functions -
Branding::resolve_file— This function returns a file's path. -
cPanel API 2 Functions -
Branding::resolvelocalcss— This function returns the path to the account'slocal.cssfile. -
cPanel API 2 Functions -
Branding::savelocalcss— This function creates or updates thelocal.cssfile. -
cPanel API 2 Functions -
Branding::setbrandingpkgstatus— This function enables or disables the current branding package. -
cPanel API 2 Functions -
Branding::showpkgs— This function lists available branding packages. -
cPanel API 2 Functions -
Branding::spritelist— This function lists sprite information and locations.