Steps for Creating a Custom WordPress Package

STOP! Are you running WordPress Auto-Provision v3.0 or greater? Try out the new automated WordPress Package Builder instead of following the manual extraction steps below!

Below are the recommended steps for creating a customized version of WordPress to use with the provisioning module:

Step 1: Install a Default WordPress Site (skip to Step 3 if you already have a template site developed)

  1. Go to Addons -> WordPress Auto-Provision and ensure that a default WordPress configuration exists. If an existing product configuration does not exist, please refer to our installation guide for assistence.

  2. Go to Clients -> Add New Client and create a test client account with a valid e-mail address.

  3. Go to Orders -> Add New Order and add your WordPress product to the test client account. Note: We recommend setting the Order Status to Active and the Billing Cycle to Free for testing purposes. 

  4. Go to Clients -> View/Search Clients and click on the test client profile. Click on the Products/Services tab and then select the WordPress product from the dropdown menu (if the test client has more than one product assigned).

  5. Press the CREATE module command button to run the module and provision a new WordPress site using default settings.

    This serves two purposes: It tests the module in its default state to ensure everything is working correctly and it provides you with a fresh WordPress install to configure your themes, plugins, and language files.

Step 2: Customize WordPress

  1. Log into the new WordPress site that was created by the module (WordPress credentials will be sent to the client e-mail address during provisioning) and begin installing your custom themes, plugins and language files.

Note: How you configure the site at this point is exactly how it will be provisioned for new users later.

Step 3: Download a Copy of the Customized WordPress Site

  1. Log into your cPanel or DirectAdmin hosting control panel and launch the File Manager.

  2. Navigate to the root folder for your customized WordPress template site and compress the entire folder, creating a new archive file. (Note: We recommend making a .tar.gz archive file to speed up the download/upload process). 

  3. Download the newly created archive file to your desktop. 

Step 4: Export the Customized WordPress Database

  1. Log into the phpMyAdmin interface from your hosting control panel.

  2. Select the customized WordPress site's database on the left-hand side (you don't need to expand it).

  3. Press the Export tab on the right-hand side. Leave the default settings and press the "Go" button to generate the database export file. Save this file to your desktop. 

Step 5: Create a New WordPress Package

  1. Log into the hosting account control panel for your WHMCS site and launch the File Manager (or launch an FTP session into your WHMCS file directory).

  2. Navigate to [WHMCS Root]/modules/addons/appprovisionwp/packages . Select the "default" folder and make a copy of it, changing the title to what you want to call your new template package. Open the new package folder and you should see a folder structure that looks like looks like this.

  3. In the root of the package folder, delete the file database.sql. Upload the WordPress database export from your desktop and rename it to database.sql.

  4. While still in the root of the package folder, upload the WordPress site archive file from your desktop. Select the archive file once you have uploaded it and press the Extract button (if using an FTP client, you may need to manually export the files to a folder on your desktop and then upload them into the package folder). This will create a new folder called "public_html" (or whatever the root folder of your WordPress site was called). Open this new folder and move ALL of the contents into the package folder "files" folder (e.g. [WHMCS Root]/modules/addons/appprovisionwp/packages/[your-package-folder]/files . Delete the archive file that you had uploaded and the now empty "public_html" folder (or whatever the root folder of your WordPress site was called) from the package folder.

  5. Once completed, you should end up with a package folder structure that looks like this.

Wrap Up

Finally, log back into the WHMCS admin interface and:

  1. Go to the WordPress configuration settings interface (under Addons -> WordPress Auto-Provision ) and create a new WordPress configuration settings profile or modify an existing one.

  2. Select the new WordPress package folder from the Package Folder drop down menu and click Save.

  3. Open a client profile assigned to the associated WHMCS product for the new WordPress package and run the module to provision a new site. Verify that the new site looks like the template site and that all settings are working correctly.
  • 2 Users Found This Useful
Was this answer helpful?

Related Articles

RegEx Pattern Matching

As of WordPress Auto-Provision Module version 2.4, a new RegEx pattern matching feature allows...

Installation Steps

Getting Started Download and install the latest release of the WordPress Auto-Provision module...

Product Module Commands

Once a client has purchased a WordPress hosting account, the following module commands will be...

Product Addon Module Commands

If a WordPress site is provisioned using a product addon, there are no module commands available...

WordPress Single Sign-On (SSO)

As of WordPress Auto-Provision Module version 2.3, WHMCS administrators can now login to the web...