Page tree
Skip to end of metadata
Go to start of metadata

This document is for a previous release of cPanel & WHM. To view our latest documentation, visit our Home page.

For cPanel & WHM 11.40


(Home >> Development >> cPanel Plugin File Generator)

Overview

This interface allows you to generate an installation file for a cPanel plugin. The installation file automates the plugin installation process and stores the desired configuration for your plugin. 

Note:

For more information about how to install a cPanel plugin and check its functionality, read our Guide to cPanel Plugins documentation. 

Generate an installation file

To generate a plugin installation file, perform the following steps:

  1. Enter the plugin name, display name, and plugin description in the appropriate text boxes.

  2. To add the plugin as an option in WHM's Feature Manager  interface (Home >> Packages >> Feature Manager), select the Feature Manager Support checkbox.
  3. Select the icon group in which the plugin icon will appear from the Group menu.

    • To create a new icon group, select  Create a New Group , and then enter the name of the new group in the New Group Name text box that appears.
  4. Enter a number between 1 and 999 in the Display Order Priority text box to specify the icon's display priority. 
    • The default value is 999, which will place your plugin's icon last in display order.
  5. Enter the location of the plugin in the Link URL text box. 
    • This location must be relative to the /usr/local/cpanel/base/frontend/THEME_NAME/ directory, where THEME_NAME is the name of the theme (for example, x3).
    • For example, enter example in the text box to access a plugin in the /usr/local/cpanel/base/frontend/THEME_NAME/example file.
  6. Enter HTML tags that you wish to add to the link tag for the plugin in the Extra Link Attributes text box.
    • For example, target="_blank"
  7. Enter JavaScript that you wish to execute when a user clicks on the plugin link in the "onclick" Event Handler text box. 

    • For example, -JavaScript_HERE_;return false;
  8. Click Choose File to select and upload an icon for your plugin.

    Notes:

    • Icons must be 32x32 pixels and must use the JPG or PNG formats.
    • The system automatically resizes images that are not the correct size.
    • Icons cannot be transparent.
  9. Click Submit.
  • No labels