BuycPanel Blog

BuycPanel Blog

Latest news and updates

Introduction to the WHM Plugin

Posted by Allura on 20 12 2018.

Introduction
WHM plugins helps in adding new functionality to the WHM interface.

We see that the cPanel plugin requirements and WHM plugin requirements are non-identical. For more information about the cPanel plugins, one can read the Guide to cPanel Plugins documentation.

One can read the Guide to Testing Custom Code documentation or help to troubleshoot issues with WHM plugin development.

It is important to note that cPanel & WHM versions 64 and 66 includes major updates to the WHM interface affecting most of the WHM plugins. If the plugin for cPanel & WHM version 62 or earlier is developed by the user, one must update it.

Plugin Development Workflow
One can read the Create a WHM Plugin tutorial to get more information on this feature.

Steps of workflow when a WHM plugin is created:
Steps:

 	Firstly, one needs to create the custom application (the plugin’s backend code).
 	Then one can create the plugin’s interfaces and other files.
 	Thirdly,…

Introduction

WHM plugins helps in adding new functionality to the WHM interface.

We see that the cPanel plugin requirements and WHM plugin requirements are non-identical. For more information about the cPanel plugins, one can read the Guide to cPanel Plugins documentation.

One can read the Guide to Testing Custom Code documentation or help to troubleshoot issues with WHM plugin development.

It is important to note that cPanel & WHM versions 64 and 66 includes major updates to the WHM interface affecting most of the WHM plugins. If the plugin for cPanel & WHM version 62 or earlier is developed by the user, one must update it.

Plugin Development Workflow

One can read the Create a WHM Plugin tutorial to get more information on this feature.

Steps of workflow when a WHM plugin is created:

Steps:

  • Firstly, one needs to create the custom application (the plugin’s backend code).
  • Then one can create the plugin’s interfaces and other files.
  • Thirdly, one needs to create an installation script.

It is important to note that this script needs to register one’s plugin with AppConfig and perform several other actions.

  • Then one must create one’s plugin’s AppConfig configuration file.
  • One can compress one’s plugin’s files for distribution.
    • We recommend on compressing one’s plugin’s files into a tarball (.tar.gz) file to make it easy for distribution.
    • The compressed file must contain the application source files, the AppConfig configuration file, an upgrade script, and an installation script for most plugins.
  • One can distribute the plugin. When one does so, across multiple servers, system administrators must perform the following actions manually:

– Decompressing the plugin’s .tar.gz file.

–  Running the installation script.

Conclusion

Users can make a use of this feature with proper steps as outlined in the review.