.pdf)
WHM Plugins
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | List branding packages available to the user. This function also returns any relevant information about each branding package. |
| Parameters: | |
| onlyshowyours (boolean (optional)) | |
| This parameter allows you to specify whether to only return branding packages the user owns. '1' indicates that only packages owned by the user should be returned. | |
| showroot (boolean (optional)) | |
| This parameter allows you to specify whether to only return system branding packages. '1' indicates that only system branding packages should be returned. | |
| skipglobal (boolean (optional)) | |
| This parameter allows you to specify whether to only return customized branding packages. '1' indicates that only customized branding packages should be returned. | |
| skiphidden (boolean (optional)) | |
| This parameter allows you to specify whether to skip branding packages owned by the user. '1' indicates that user-owned branding packages should be skipped. | |
| Returns: | |
<data> <types> A hash for each type of branding package returned: <typetxt> A string value that indicates whether the branding package is a system package or a user-owned package. 'System' indicates that the package is a system default branding package. 'Yours' indicates that the package is a user-owned branding package. This variable is defined in the 'cpanelbranding' directory in your home directory.</typetxt> <pkg> A string value that contains the name of the branding package.</pkg> <type> A string value that indicates whether the branding package is a system package or a user-owned package. 'System' indicates that the package is a system default branding package. 'Yours' indicates that the package is a user-owned branding package.</type> </types> <disabled> A boolean value that indicates whether or not the package is disabled. '1' indicates that the package is disabled while '0' indicates that the package is not disabled.</disabled> <pkgname> A string value that contains the name of the package.</pkgname> <selectopt> A string value that always returns 'selected'.</selectopt> <previewsmimg> A string value that contains a URL fragment to the small preview image for the branding package.</previewsmimg> <pkgchecked> Returns "checked" if the branding package is currently in use with the account. The string contains "unchecked" if the package is not in use with the account.</pkgchecked> <pkg> A string value that contains the name of package.</pkg> <previewimg> A string value that contains a URL fragment to preview image for the branding packages.</previewimg> </data> |
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | Retrieve URL locations for specific sprites. This function also returns associated image information when appropriate. |
| Parameters: | |
| image (string (optional)) | |
| This parameter allows you to force appropriate output by setting it to 'heading'. | |
| img (string) | |
| The branding object label for the image you wish to retrieve. | |
| imgtype (string) | |
| The branding image type you wish to retrieve (e.g. 'icon' or 'heading'). | |
| method (string) | |
| This parameter allows you to specify returned value options. Acceptable values are: 'only_filetype_gif', 'skip_filetype_gif', 'snap_to_smallest_width', and 'scale_60percent'. | |
| skipgroups (boolean (optional)) | |
| This parameter allows you to specify whether or not to include 'img' values that begin with 'group_' in the output. '1' indicates that you wish to skip 'img' values that begin with 'group_'. | |
| subtype (string) | |
| This parameter allows you to specify a branding image subtype (e.g. 'img', 'bg', or 'compleximg'). | |
| Returns: | |
<data> <images> Note: This list may be empty. <height> An integer value that contains the height in pixels.</height> <position> An integer value that contains the CSS position. </position> <*num> A string value that contains 'odd' or 'even', indicating the position in the larger dynamicui structure.</*num> <width> An integer value that contains the width in pixels.</width> <img> A string value that contains the branding object img name.</img> <cssposition> An integer value that contains the CSS position.</cssposition> </images> <spriteurl> A string value that contains the URL fragment that indicates the location of the image. (e.g. '/cPanel_magic_revision_96949786420.6556/branding/x3/</spriteurl> </data> |
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | Retrieve a data structure that represents the icons within the x3 interface. This data structure will include icons, URLs, and descriptions. The information originates in the dynamicui.conf files for the theme and then is processed through your customizations. |
| Parameters: | |
| nvarglist (string (optional)) | |
| This parameter allows you to specify the order in which you wish to have groups returned, separated by pipes. (e.g. 'mail|files|domains|logs' etc.) This is the last filter on the data and is stored in your xmaingroupsorder nvdata variable. For more information, see the NVDATA module or /home/user-name/.cpanel/nvdata/. | |
| Returns: | |
<data> <group> A string value that contains the branding group. (e.g. 'mail' or 'domains')</group> <desc> A string value that contains a description of the group that will appear in the title bar. (e.g. Mail)</desc> <items> Essentially a list of the icons in the group: <width> The width of the icon in pixels.</width> <itemorder> An integer value that indicates the order in the list of groups.</itemorder> <file> A string value that contains the file name of the icon.</file> <itemdesc> A string value that contains the name of the item. (e.g. Email Accounts)</itemdesc> <height> The height of the icon in pixels.</height> <feature> A string value that contains the associated cPanel feature. (e.g. popaccts)</feature> <subtype> A string value that contains the subtype of the branding object. (e.g. img)</subtype> <group> A string value that contains the branding group to which the icon belongs. (e.g. mail)</group> <imgtype> A string value that contains the branding image type. (e.g. icon)</imgtype> <searchtext> A string value that contains search keywords for the javascript search-in-page. (e.g. 'pop', 'imap', or 'pop imap smtp new account')</searchtext> <url> A string value that contains the URL-ending to reach the page in cPanel that corresponds to the function. (e.g. 'mail/pops.html')</url> <type> A string value that contains the type of branding object. (e.g. image)</type> </items> </data> |
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | List branding object types used by the current style and customizations of the current theme. |
| Returns: | |
<data> <type> An object type used by the current theme. (e.g. 'css' or 'html')</type> </data> |
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | List Branding 'imgtypes' used by the current style and customizations of the current theme. |
| Returns: | |
<data> <imgtype> A string value that contains an image type for the current theme. (e.g. 'preview' or 'ui')</imgtype> </data> |