Personal tools
Namespaces

Variants
Actions

WordPress Manager For WHMCS

From ModulesGarden Wiki
Jump to: navigation, search

Contents

About WordPress Manager For WHMCS

WordPress Manager For WHMCS is a module that enables your customers to control and freely alter their WordPress instances right inside your WHMCS.

Your clients will be able to add WordPress installations using instance images and custom scripts, perform WordPress updates, install themes and plugins, create staging instances and then push them live.
All of that just next to the basic upgrade options. You will easily handle the list of services that shall include the WordPress management capabilities.

  • Admin Area:
✔ View Active WordPress Installations, Clients And Products Summary
✔ View WordPress Installations List
✔ Choose Supported Products:
✔ Select Available Installation Scripts
✔ Select Available Plugin Packages
✔ Select Available Instance Images
✔ Automatically Install:
✔ WordPress After Service Creation:
✔ Based On Installation Script
✔ Based On Instance Image
✔ Plugin Packages
✔ Theme Packages
✔ Toggle Blocking Plugins
✔ Toggle Automatic Deletion Of Blocked Plugins
✔ Add/Remove Selected Plugins From Blacklist:
✔ Prevent Blacklisted Plugins From Being Installed By Clients
✔ Remove Blacklisted Plugins From Current Installations
✔ Set Scan Interval For Blacklist Cleaner
✔ Toggle Debug Logs
✔ Create Plugin Packages:
✔ Enter Package Name And Description
✔ Choose Available Plugins
✔ Create Theme Packages:
✔ Enter Package Name And Description
✔ Choose Available Themes
✔ Create Instance Images:
✔ From Local Or External Installation Source
✔ Public Or Private
✔ Access Module Tasks List And Logs
  • Client Area:
✔ View/Create/Edit/Delete WordPress Installations
✔ View/Create/Edit/Delete WordPress Installations On Your Resellers Accounts:
✔ cPanel
✔ DirectAdmin
✔ Update Selected WordPress Installations To Newest Version In One Batch
✔ Import WordPress Installation From Remote Server
✔ Create WordPress Installation Based On Instance Image
✔ View Installation Details:
✔ Domain And URL
✔ Product On Which Is Installed
✔ WordPress Version
✔ Site Name
✔ Creation Date
✔ Directory Path
✔ Database Access Details
✔ Debug Status
✔ Instance Status
✔ Manage Installation:
✔ Create/Restore/Download/Delete WordPress Backups
✔ Browse/Install/Manage Themes
✔ Search And Install Themes Directly From WordPress.com Base
✔ Preview Theme Before Installation
✔ Activate/Deactivate Installed Themes
✔ Update Installed Themes
✔ Browse, Install And Manage Plugins
✔ Search And Install Plugins Directly From WordPress.com Base
✔ Activate/Deactivate Installed Plugins
✔ Update Installed Plugins
✔ Browse And Install Plugin Packages
✔ Perform Bulk Changes On Themes, Plugins, And Backups
✔ View/Create/Edit/Delete WP Config Records
✔ Perform Actions:
✔ Log In To Control Panel
✔ Clear Cache
✔ Clone To New Domain
✔ Update To Newest Version
✔ Change Domain
✔ Toggle Auto Upgrade Of:
✔ WordPress Installation
✔ WordPress Plugins
✔ WordPress Themes
✔ Create Staging
✔ Push Staging To Live Environment
✔ Enable/Disable SSL
✔ Create Instance Image
✔ Delete
  • Supported Modules:
✔ cPanel
cPanel Extended - With Complete Integration
✔ DirectAdmin
DirectAdmin Extended
✔ Plesk
Plesk Extended
  • General Info:
✔ Requires Softaculous Auto Installer
✔ Automatic Let's Encrypt SSL Installation (DirectAdmin Only)
✔ Multi-Language Support
✔ Supports PHP 5.6 Up To PHP 7.3
✔ Supports WHMCS Template Six
✔ Supports WHMCS V7.7 And Later
✔ Easy Module Upgrade To Open Source Version

Installation and Configuration

In this short tutorial we will show you how to successfully install WordPress Manager For WHMCS.

We will guide you step by step through the whole installation process.

1. Log in to our client area and download the module.
WM2 1.png
2. In the downloaded file you might find one or two packages that support different PHP versions.

In the most recent versions of the module, you will find only one package that supports PHP 7.1 and later.
If you need a package for the previous versions of PHP, please contact our support.

PHP71 73.png
Previous updates of the module may contain two packages dedicated to various PHP versions.

The first one that supports PHP 5.6 up to PHP 7.0, and the second one addressed to PHP 7.1 up to PHP 7.3.
Note: Keep in mind that PHP versions 5.6 up to 7.0 are no longer officially supported and their security issues are not fixed or released any more. Find more info here.

PHP56 73.png
Important: This situation does not affect the open source version of this module which can be applied to any PHP from version 5.6 and later.
Note: You can check the current PHP version in your WHMCS. To do so, proceed to 'Utilities' → 'System' → 'PHP Info'.
3. Once you have chosen the package with the right PHP version, extract it and upload its content into the main WHMCS directory.

The content of the chosen PHP version files to upload should look like this.

WM 1s2.png

cPanel (WHM) Installation

1. Upload and extract the 'UploadToWHM' folder into the /root cPanel directory.

Files in your cPanel /root/uploadToWHM/ directory should look like these on the following screen.

WM 2.png
2. Once the module is uploaded, enter the /root/uploadToWHM/ catalog and run the following command in the console:
sh install.sh

After a brief moment you should see a confirmation that the plugin has been successfully installed.

WM 3.png

DirectAdmin Installation

1. In the 'uploadToDirectAdmin' folder find the 'wordpress_cli.tar.gz' package.

Next, log in to your DirectAdmin panel as an administrator and go to 'Plugin Manager' .

WM 2 1.png
2. Once in the 'Add Plugin' , select the 'File' option and choose the 'wordpress_cli.tar.gz' package to upload.
Additionally, mark the 'Install after upload' option and press the 'Add Plugin' button.
WM 2 2.png
3. Once the plugin is uploaded and successfully installed, you should see it on the plugins list.
WM 2 3.png

Plesk Installation

Note: The current version of the module requires your Plesk server configured in WHMCS to use username and password as authentication to the Plesk API.
We also recommended using Plesk in at least 17.8.11 version.
1. In the 'uploadToPlesk' folder find the 'wordpress-manager-cli-X.X-X.zip' package.

Next, log in to your Plesk panel as an administrator and go to the 'Extensions' section.

WM 3 1.png
2. Once you are in the 'Extensions' section, go to the 'My Extensions' tab and select the 'Upload Extension' option.
In the opened window choose the 'wordpress-manager-cli-X.X-X.zip' package to upload and press the 'OK' button.
WM 3 2.png
3. Once the plugin is uploaded and successfully installed, you should see it on the plugins list.
WM 3 3.png

WHMCS Installation

1. Extract the 'modules' catalog into the main WHMCS directory.
WM S2 2.png
2. When you install WordPress Manager For WHMCS for the first time, you have to rename the 'license_RENAME.php' file.

This file is located in 'modules/addons/wordpress_manager/license_RENAME.php.' Rename it from 'license_RENAME.php' to 'license.php'.

WM S3.png
3. In order to configure your license key, you have to edit the previously renamed 'license.php' file.

Enter your license key between quotation marks as presented on the following screen. You can find your license key in our client area → 'My Products'.

WM S4.png
4. In the next step, set up the 'storage' folder as recursively writable.

This folder is available at 'your_whmcs/modules/addons/WordpressManager/' .

WM S4s.png
5. Now you have to activate the module in your WHMCS system.

Log in to your WHMCS admin area. Click 'Setup' , then choose 'Addon Modules'.
Afterwards, find 'WordPress Manager' and press the 'Activate' button.

WM2 6.png
6. Then, you need to permit access to this module. To do so, click on the 'Configure' button, choose 'Full Administrator' and press 'Save Changes'.
WM2 7.png
7. Now you have to add a cron job as shown below (5 - 10 minutes interval is recommended).

This cron job is responsible for both: synchronization of WordPress installations and 'Enable SSL' action when installing new WordPress instances.

php -q /your_whmcs/modules/addons/WordpressManager/cron/cron.php Synchronize

Do not forget to replace 'your_whmcs' with your WHMCS root location.
Note: In case you wish to stop this cron job then move to "your_WHMCS/modules/addons/WordpressManager/cron" directory and clear the file's content.

8. Good job! You have just successfully installed WordPress Manager For WHMCS! Now in your WHMCS press 'Addons' and then 'WordPress Manager'.
WM2 8.png

Management

This section has been divided into two main parts to allow full and, at the same time, easy understanding of the functionality of the whole module.
In the first part 'Management of Addon' you will see a general outlook of the module's basic configuration, through the product management from the admin area.
The second part describes additional settings and tools concerning WordPress installations that can be used while working in the client area.

Admin Area

Now that your module is already configured, you may access it at 'Addons' 'WordPress Manager'.

Home

The 'Home' section is the first open when entering the addon.

You will see here a quick summary of the WordPress connected elements and a list of all active WordPress installations with any details on their installation.

WM2 9.png

Product Settings

In the 'Product Settings' section you can see the list of compatible products present in your system that WordPress can be configured with.

Activate the products and press the 'Edit' icon marked on the screen below.

WM2 10.png

General

In the 'General' section you set up some specific options concerning the plugins installation. Take a look at the below notes to learn about all the possibilities.
  • Debug Mode - if enabled, the module's activity details will be gathered in the 'Logs' subsection.
  • Installation Scripts - allow your clients to install your pre-configured WordPress instances instead of performing a clean installation only.
    This feature can be useful if you already have a few WordPress installations ready, such as custom theme with a demo content or other plugins.
    If you leave this field empty, then a clean WordPress instance will be installed by default.
    Important: The dropdown will display a bunch of other installation scrips from Softaculous, not only those from WordPress.
    Remember to only select your WordPress-based installations. Otherwise, unpredictable errors might occur.

  • Test Installation - in order to get the list of applications in the Plugins Blacklist search, you must have at least one active WordPress instance, otherwise, API will show no results. Select one from the available.
  • Blocked Plugins - enable if you do not wish your clients to install certain plugins due to security, safety or any other reason.
    Define the plugins that will not be allowed for installation in the Plugins Blacklist section.
  • Delete Blocked Plugins - enable if you wish to automatically delete plugins that have been added to the blacklist.
    Remember that the pointed here plugins will also be removed from the already existing WordPress instances.
  • Scan Interval [Hours] - the products will be scanned using a cron job in the provided time intervals, suggested time interval - every 3 hours.
    Please do not set it more often as the server may be overloaded during the scan. It works only if the 'Delete Blocked Plugins' option has been enabled.
  • Plugin Packages - select any packages containing a bunch of preselected plugins that can be later quickly installed, read more about them in the section Plugin Packages.
  • Auto Install Plugin Packages - choose which plugin packages will be installed automatically when a new WordPress instance is created by a client. Read more about them in the section Plugin Packages.
  • Auto Install Theme Packages - choose which themes packages will be installed automatically when a new WordPress instance is created by a client. Read more about them in section Theme Packages.
  • Instance Images - select which of the existing images clients will be allowed to use to add new installation, read more about them in the section Instance Images.
  • Auto Install WordPress After Service Creation - you may here decide whether the WordPress instance should be automatically installed once the client's service is created:
    • Disabled - select if you do not want the WordPress instance to be automatically installed after provisioning the product.
    • Based On Instance Image - if chosen the new dropdown will appear where you can choose the instance image based on which the WordPress will be automatically installed.
    • Based On Installation Script - if selected, then in the new dropdown you can choose which of the installation scripts install the WordPress instance after service creation.
  • Welcome Email - select a email template that will be sent to the customer with WordPress installation details when auto installation is done.
    By default, the module will also create the 'New WordPress Information' sample template which you can use or familiarize yourself with the available merge fields variables.
WM2 11.png
Note: By default, installation script names in the client area will be displayed without their IDs. If you want to still change their names to more client-friendly, you can do it in a language file.
Go to the Tips section and look for more details in the second point.

Plugins Blacklist

This section of the Product Settings includes a list of blocked plugins - those which your clients are not allowed to install.
In order to add a plugin to the list simply start typing its name in the search field and press enter to see the results.
Remember that you must have previously set any "Test Installation" to be allowed to add any plugins to the list.
WM2 12.png
Add the selected plugin to the blacklist.
It will no longer be available for clients to install if the "Blocked Plugins" option has been enabled in the General section.
WM2 13.png

Plugin Packages

In the 'Plugin Packages' you may prepare ready made packages with selected by you plugins and then offer them to install to your clients.

In this quick and convenient way, your clients will be given an offer with perfectly adjusted and suitable plugins to shorten the time of searching and verification.
You may also use this package to automatically preinstall given plugins when a client creates a new WordPress instance.
Prepare packages, enable when ready or disable when you want to withdraw them from the offer temporarily or edit their content and surely delete when no longer needed.
Press 'Create Package' to compose the bundle.
Note: Plugins included in the packages are always installed in their newest version available in the WordPress base.

WM2 14.png
In the 'General' part, enter the package name, select the directory of the test installation, describe the package in short. Save the changes and then move to the 'Plugins' tab.
In this part you will also need to enable the package once it is prepared.
WM2 15.png
Add plugins by searching through the existing ones, start typing the plugin name, press enter and the results will appear.
Add a single plugin or use mass action button to add plugins in bulk.
WM2 16.png
Added plugins will appear on the list of included immediately. You may always delete any unwanted plugins when editing the package by pressing the bin icon.
WM2 17.png
Once you have the packages ready, move again to the General configuration of a product and select which of the packages will be available to choose from by clients or be automatically preinstalled for a single product.
Surely, you may assign a different set of packages to each product.
WM2 17 1.png

Theme Packages

In the 'Theme Packages' you may prepare ready made packages with selected by you themes and automatically install them along with the WordPress instance.

In this quick and convenient way, your clients will have quick access to preinstalled themes on their WordPress without the need of searching them on their own.
Prepare packages, enable when ready or disable when you want to withdraw them from the installation temporarily or edit their content and surely delete when no longer needed.
Press 'Create Package' to compose the bundle.
Note: Themes included in the packages are always installed in their newest version available in the WordPress base.

WM2 2 14.png
In the 'General' part, enter the package name, select the directory of the test installation, describe the package in short. Save the changes and then move to the 'Themes' tab.
In this part you will also need to enable the package once it is prepared.
WM2 2 15.png
Add themes by searching through the existing ones, start typing the theme name, press enter and the results will appear.
Add a single theme or use mass action button to add themes in bulk.
WM2 2 16.png
Added themes will appear on the list of included immediately. You may always delete any unwanted themes when editing the package by pressing the bin icon.
WM2 2 17.png
Once you have the packages ready, move again to the General configuration of a product and select which of the packages will be installed automatically for a single product.
Surely, you may assign a different set of packages to each product.
WM2 2 17 1.png

Instance Images

This section is dedicated to WordPress images that are used to allow clients to add WordPress installations using this very images of WordPress.
To create such an image, simply press the 'Add New' button and then follow the steps described below.
WM2 18.png
In order to properly configure a new instance image you will need to set up the below options.

Please be aware that to create such an instance image you will need to deliver full access data to a server with WordPress installations that will be used to create an image.
Once a client decides to use an image to add an installation, he will be connected with the server, WordPress instance downloaded and installed.
The whole process may take from a few up to a dozen or so minutes, depending on the instance complexity.

  • Enable - enable the image when it is ready to allow for clients to use.
  • Custom - if you toggle custom images, you will need to provide a custom name of the installation and domain that will be used.
  • Installation - select existing installation of WordPress to configure instance images.
  • Private - if disabled, the instance will be visible to all clients who own a product with an assigned instance (more details here).
    'Private' flag is assigned to an instance image created by a client, which is visible to the client who has created it.
  • Name - give the instance image a unique name.
  • Protocol - select protocol form: 'FTP', 'FTPS' and 'SFTP' to connect.
  • FTP Path - define the path to the directory that is relative to the home directory of the users.
  • Server Host - host used to connect via FTP.
  • Server Port - port number to connect to the FTP server.
  • FTP User - user to connect to the FTP server.
  • FTP Password - password for user to connect to the FTP server.
WM2 19.png
Once you have the images ready, move again to the General configuration of a product and select which of the images will be available for a single product.
Surely, you may assign different sets of images to each product.
WM2 19 1.png

Other

Logs

The module activities are recorded in the section named 'Logs'. All entries can be deleted at any time, just click the button marked on the screen below.
Keep in mind that you can remove multiple logs at once.
WM2 21.png

Tasks

This section gives you the view on module tasks to enable SSL in two scenarios:
  • for newly created installations
  • when creating staging instances
WM2 23.png
Press the 'Information' button to get a quick view on the basic information on the task and log details.
WM2 24.png
Logs section will include information on errors only. If a task is completed successfully, no information will be included here.
WM2 25.png
All tasks can be deleted separately. To do that, just click the button marked on the screen below.
Keep in mind that you can remove multiple tasks at once.
WM2 25 1.png

Email Templates

By default, the module creates the 'New WordPress Information' email template You can find it in your WHMCS 'Setup' 'Email Templates' section.

This template can be used to send WordPress details to the customer when the automatic installation is enabled after the service creation.
You can also modify that template, create your own and assign it to the service it in the product general settings.

Additionally, you may use the merge fields variables, which will be replaced to the corresponding WordPress installation details when are sent to the customer:

  • {$installation.domain} - WordPress installation domain
  • {$installation.url} - WordPress installation URL
  • {$installation.version} - WordPress version
  • {$installation.path} - WordPress installation path
  • {$admin_username} - generated WordPress username
  • {$admin_pass} - generated WordPress password
  • {$installation.id} - ID of the WordPress instance in your WHMCS. It can be used to prepare URL that will redirect customer directly to the instance in their client area.
    E.g. {$whmcs_url}/index.php?m=WordpressManager&mg-page=home&mg-action=detail&wpid={$installation.id}
  • {$adminurl} - directory path to the WordPress admin control panel. It should be used with the {$installation.url} veriable. E.g. {$installation.url}/{$adminurl}
WM2 25 2.png

Client Area

Now that you already have the module configured, you may see the process of adding and managing the WordPress installations by your clients.
In the client area, find and choose your product with WordPress management support and then move directly to the relative section.
WM2 26.png

WordPress Installations

WordPress Management page is divided into two parts: 'WordPress Installations' and 'Reseller Accounts'.

The former one, located at the top of the page, contains a list with basic information regarding every installation, including the domain, related product, URL etc.
The 'Reseller Accounts' section is visible only in case such accounts are detected in the client's cPanel or DirectAdmin panels, otherwise, it is hidden.
Use action buttons marked on the screen to edit or remove single installations.

WM2 27.png
Among additional actions you will find the options to:
  • Add a new installation
  • Import the installation from a remote server
  • Create the installation form an instance image
WM2 28.png
Using mass actions you may also update multiple WordPress instances to the newest version at once.
WM2 28 1.png
You may also decide whether to create a backup of the instances before processing the update.
WM2 28 2.png

New Installations

As mentioned above, there are three ways to create a new WordPress Installation. The first basic way is to simply install a completely new and clean instance of WordPress.

Press the button 'New Installation' marked on the screen below and read the instruction to see how to install a pure new instance.

WM2 29.png
A new window split to two tabs will open.

In the first Details tab, fill in the following fields:

  • Product/Service - select hosting to install WordPress on it
  • Protocol - select protocol from among: 'https://', 'http://', 'http://www' and 'https://www'
  • Domain - provide a domain the software will be installed on.
  • Installation Script - here you can select any custom installation script that you want to install.
    Note that this field will be displayed only for domains which products have installation scripts configured in the Products Settings.
    If it is not displayed then the clean WordPress installation will be applied.
  • Plugin Packages - select plugin packages to install on WordPress, more about their configuration can be hound here.
  • Administrator Password - generate an administrator password for this new installation of WordPress.
  • Site Name - the name of a site created for the installation.
  • Language - choose a language for the installation.
  • Administrator Username - enter the administrator account username for this installation.
  • Administrator Email - enter the administrator account email address for this installation.

Note that only those fields marked with * (e.g. 'Site Name') are required to complete the creation.

WM2 30.png
Complete the configuration by switching to the Other tab and enter the remaining fields (optional):
  • Description - describe the installation site shortly.
  • Directory - provided here directory is relative to your domain, leave empty to install on your domain or enter e.g. 'dir' to install on http://mydoamin/dir/.
  • Database Name - the name of a newly created database which will be created during the installation.
  • Database Prefix - the table prefix for the tables created by the app (optionally).
  • Multisite - if enabled, your blog will have the 'Multisite' option. Note that your server must support 'Apache mod_rewrite'.
  • Auto Upgrade - if enabled, the WordPress installation will be automatically updated to the latest version when it is available.
  • Auto Upgrade Plugins - if enabled, all active WordPress plugins installed for this installation will be automatically updated to the latest versions when available.
  • Auto Upgrade Themes - if enabled, the active WordPress theme for this installation will be automatically updated to the latest version when available.

If you have entered all the data correctly, you can now press the 'Create' button to complete the installation.
Note: data in 'Other' section are not required to create the instance successfully, it can be simply skipped.

WM2 31.png
Import From Remote Server
The second way to add a new installation is by importing an existing installation from a remote FTP server. Press the additional actions button to find the redirection.
WM2 32.png
First of all, fill out the data on the source server:
  • Domain - domain name where the source script is located
  • Server Host - used as a host to connect via FTP
  • Protocol - protocol used for connection to the domain
  • Server Port port number to connect to the FTP server
  • FTP User - user used to connect to the FTP server
  • FTP Password - user password to connect to the FTP server
  • FTP Path - path to the directory relative to the home directory of a user for installations
  • Installed Path - directory under the domain where your script is installed, leave empty if installed in the root directory
WM2 33.png
Then move to the other tab, to provide any data on the destination.
  • Product/Service - choose a hosting to install WordPress on it
  • Protocol - select protocol that will be used
  • Domain - destination domain where the script will be imported
  • Directory - directory under the domain where the script will be imported. Leave blank to import to the root directory of your domain
  • Database - database name for the script

Press the 'Import' button to finalize the process.
Note: the process may take from a few up to a dozen or so minutes for the instance to appear on the list, depending on the instance size or external server connection speed.

WM2 34.png
Use Instance Image
It is also possible to use an existing instance image.
WM2 35.png
Provide the below enumerated and described details, then press 'Create' to complete:
  • Product/Service - choose hosting to install WordPress on
  • Instance Image - select WordPress instance image from client private instances and public images created by the admin
  • Protocol - select protocol that will be used
  • Domain - destination domain of on which the new instance will be imported to
  • Directory - directory under the domain, leave blank if you want to install WordPress instance in the root directory
  • Database - type in the database name for the script

Note: the process may take from a few up to a dozen or so minutes for the instance to appear on the list, depending on the instance size or complexity.

WM2 36.png

Installation Management

Once you have successfully created a new installation, you can edit its advanced options or simply remove it in case you no longer need it.
Let us view the management options and available actions now.
WM2 27.png
Installation Details
At the very first page when you enter the edit section is an exemplary configuration of your installation in the 'Management' section.
You will find there all the basic information, such as domain and database details, available at hand.
WM2 38.png
Backups
As the name suggests, this section provides you with an ability to create backups.
You are allowed to download, restore and delete a particular backup.
WM2 39.png
Surely you can delete multiple backups at once. Take a look at the screenshot below.
WM2 40.png
When creating a backup installation, decide whether to backup directory only, data directory or database. Select location and then confirm the action.

Note: Keep in mind that creating a backup might take a longer while. Backup will appear on the list when it is ready.

WM2 41.png
Themes
Here you are enabled to activate, disable, update and delete the existing theme. Add new themes to your WordPress installation in the 'Add New' tab.
WM2 42.png
In order to add a new theme, start typing in the desired theme's name in the search box, press enter to see the actual results.
You may press the theme thumbnail to preview the on wp-themes.com. Afterwards, press the icon marked on the screenshot below to continue.
WM2 43.png
Confirm the installation.
WM2 44.png
Use 'Mass Action' buttons to update or delete numerous themes with a single click.
WM2 45.png
Plugins
Here you are enabled to activate, deactivate, delete or update the already existing plugins. You can also add new plugins to your WordPress installation in the 'Add New' tab.
WM S 181.png
To add a new plugin, you are required to type in at least the initial letters of the desired plugin's name into the search field to see the actual results.

Afterwards, press the symbol marked on the screenshot below, and confirm your choice in the window that should be visible on your screen.

WM S 1811.png
Press the info icon to read its short description.
WM S 1811 0.png
In case the plugin seems interesting, just press the 'Install' button.
WM S 1811 1.png
The 'Mass Action' feature is also present in this section, so you will be able to handle multiple plugins more efficiently and at the same time.
WM S 182.png
Plugin Packages
Plugin Packages allow to install a bunch of pre-organized plugins at once. Information on how to prepare such packages can be found here.

Simply press the '+' button to install the package with plugins that seems especially attractive to you.
Note: Plugins included in the packages are always installed in their newset version available in the WordPress base.

WM2 51.png

Config

In this section you can directly alter the records from the wp-config.php file.
This file is located in the root of your WordPress file directory and contains your website's configuration details such as database connection information.
You are allowed to edit or delete already existing config records as well as create new ones.

Important: Be particularly careful when editing these config records! You can find more information about editing the 'wp-config.php' file here.

WM 20.png
When creating a new config record, enter its proper name, value and chose one of the three available types ( 'Constant', 'Variable' or 'All' ).
WM 21.png

Available Actions

In the 'Actions' area you can find the following options to:
  • Control Panel - log in to your WordPress panel directly any time you like.
  • Clear Cache - remove the cache of your installation.
  • Update - after selecting this option, your WordPress will be updated to the latest version if any is available.
  • Delete - immediately remove the complete installation along with its settings or selected parts of it
    .

Underneath you can find detailed description of all the remaining actions. Please take a look.

WM2 54.png
Clone
This action will result in cloning the installation to another domain. To clone the installation you need to:
  • Select the protocol type
  • Provide a domain where the cloned WordPress instance will be installed
  • Enter a directory - note that provided directory is relative to your domain, type in e.g. ‘’dir’’ or leave empty
  • Type in the database name

The cloned installation will appear on the list of installations after a while.

WM2 56.png
Change Domain
If you want to change the domain of your WordPress installation, simply provide here a new one.
Decide whether to create a backup at the same time and enable/disable SSL for the new domain.
WM2 57.png
Manage Auto Upgrades
Set up the automatic upgrades rules. Here you may enable or disable automatic upgrades:
  • Of the installation
  • Plugins
  • Themes
WM2 58.png
Staging
Create staging instances from an application to test the upgrades or changes before using them in the live environment.
WM2 59.png
Please be patient, as the whole process may take a few minutes. The staging instance will appear on the list of your installations after the first cron synchronization.

Push the staging installation to the live environment once you are sure it works fine and changes suit your needs.

WM2 60.png
In case you need to customize the installation before pushig it live simply toggle the 'Customize' option.
Then define the specification and confirm to finish.
WM2 60 1.png
SSL
Turn on or off SSL for the installation. Remember that enabling SSL will result in changes being made in your WordPress database configuration, it is advised to back up your installation.

Along with enabling SSL, a free Let's Encrypt SSL will be installed on DirectAdmin products (note that this feature is not available for 'cPanel').
Toggle the 'Create Backup' option and then confirm the actions.

WM2 61.png
Instance Image
Turn on instance image on the WordPress installation. Simply, toggle the 'Mark As Image' option and then fill in the below options.

Note: The 'FTP Password' input is encoded in the database, which makes is completely safe and secure.

WM2 63.png

Reseller Accounts

Existing Reseller's Accounts with the number of WordPress installations. Keep in mind that this section is visible only when such accounts exist in the client's cPanel or DirectAdmin panels.
In case no such accounts have been detected, this section is hidden.

Note: Plesk resellers accounts are not yet currently supported.

The table includes the name of the product, reseller's account name on which the instances are installed as well as their number.

WM2 64.png
Press the edit icon to view the list of existing installations. Among other allowed actions there are:
  • Add New Installation
  • Import From Remote Server
  • Use Instance Image
WM2 65.png
The only difference is the need to select a customer when adding a new installation.
If there is no username available here to choose, the reseller must create an extra account in the cPanel or DirectAdmin panels.

All the remaining options are exactly the same as in case of standard WordPress installations described in the above sections.

WM2 66.png
Using mass actions you may also update multiple WordPress instances to the newest version at once.
WM2 66 1.png

Tips

1. In case you wish to remove one of your plugins from WHM, make sure you delete the additional content too:
/usr/local/cpanel/Cpanel/API/Wordpress.pm
/usr/local/cpanel/share/WordPressManager/wp
2. If you wish to change the names of your WordPress installations scripts to more friendly in the client area, you can do this in a language file.
Simply open your default 'english.php ' file located in '/yourWHMCS/modules/addons/WordpressManager/langs' directory and add a new language record in the following format:
$_LANG['WordPress Script Name']="WordPress Friendly Name";
3. When using WordPress Manager module with cPanel, you will also need to whitelist 'phar' support in your php.ini on the WHM server.
You can do this by adding or editing the below record:
suhosin.executor.include.whitelist = phar

Update Instructions

An essential guidance through the process of updating the module is offered here.

Important: If you are performing an update from a previous version of WordPress Manager with cPanel, you have to also update the files and run again the installation script on your WHM server.
Simply go here and repeat the following instructions.

Keep in mind there is a quick and easy option in our client area that will let you upgrade the license of your module to an open source version at any time - and at a lower price!
To take advantage of it, simply use the 'License Upgrade' button located on the product's page and a discounted invoice will be generated automatically.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
2. If you do not see the config records, make sure that you have also updated the WHM files to the latest version.
3. Installation of Let's Encrypt SSL is available only for DirectAdmin products.
4. Native integration with cPanel Extended module is supported only up to version 1.2.1 of WordPress Manager. Further versions are currently not compatible.
Please do not update your WordPress Manager For WHMCS to 1.3.0 or later if you are actively using the integration. This feature will be restored in the future.
Navigation
WHMCS Modules
WHMCS Translations
cPanel Modules
Magento Extensions
Magento Themes
PrestaShop Modules
Blesta Extensions
General
FAQ
Community
WordPress Manager For WHMCS