Personal tools


Client Area Popup For WHMCS

From ModulesGarden Wiki
Jump to: navigation, search


About Client Area Popup For WHMCS

Client Area Popup For WHMCS is a module that lets you create fully customized pop-ups that will be visible to your clients in their panel.
Prepare a ready pop-up in a form of an image, raw or HTML text to pass a message directly to your clients.
Design it using predefined styles, which can be always altered and upgraded to implement your idea perfectly.
  • Admin Area Features:
✔ Create Informative And Advertisement Pop-Ups
✔ Compose Pop-ups Using Predefined Styles
✔ Preview Pop-up With Single Click
✔ Archive Pop-ups For Later Use
✔ View Pop-up Restrictions
✔ View Number of Pop-up Displays
✔ View Pop-up Delay Time
✔ View Pop-up Status
✔ Create Styles To Be Used By Pop-up
✔ Preview Style With Single Click
  • Client Area Features:
✔ View Pop-up If Restrictions Are Met
✔ Close Pop-up Permanently
  • Pop-up:
✔ Define Pop-up Restrictions:
✔ Display Frequency - How Often Pop-up Should Be Displayed
✔ Options For Client To Close Pop-up Permanently
✔ Visible To Logged In Users - Display Pop-up To Registered Clients
✔ Visible To Not Logged In Users - Display Pop-up To Guests
✔ Pages - Define Pages Where Pop-up Is Displayed
✔ Invoice To Pay - Display Pop-up To Users With Unpaid Invoices
✔ Days - Specify Days Of The Week When Pop-up Is Displayed
✔ Required Languages
✔ Required User Groups
✔ Required Active Products
✔ Required Active Products In Groups
✔ Required Active Products With Servers
✔ Required Active Addons
✔ Required Active Domains With Chosen TLDs
✔ Lack Of Chosen Active Products
✔ Lack Of Chosen Active Addons
✔ Lack Of Active Domains With Chosen TLDs
✔ URL Contains - Define Phrase Used In Link Address To Activate Pop-up
✔ Define Due Date Restrictions:
✔ Display Pop-up Before, After And On Service Due Date
✔ Specify Conditions With 'Less Than', 'Equal To' And 'Greater Than' Options
✔ Define Number Of Days Applied To Condition
✔ Specify Active Services
✔ Specify Services' Status
✔ Define Timing:
✔ Date Frames - Start And End Date For Pop-up To Be Displayed
✔ Time Ranges - Hours Interval When Pop-up Is Displayed
✔ Delay Time - After How Many Seconds Pop-up Is Displayed
✔ Display Limit - How Many Times Pop-up Is Displayed For Everyone Or Per Client
✔ Define Pop-up Size
✔ Define Pop-up Animation:
✔ Fade In
✔ Slide From Chosen Direction
✔ Assign Style To Pop-up
✔ Choose Type And Provide Pop-up Content:
✔ Text With WYSIWYG Editor
✔ Raw HTML
✔ Image
✔ Auto-synchronize Pop-up Status Basing On Start And End Date
  • General Info:
✔ Supports WHMCS Themes "Six" And "Twenty-One"
✔ Multi-Language Support
✔ Supports PHP 8.1 Back To PHP 7.4
✔ Supports WHMCS V8.10 Back To WHMCS V8.6
✔ Requires ionCube Loader V12 Or Later
✔ Easy Module Upgrade To Open Source Version


This tutorial will show you how to successfully install and configure Client Area Popup For WHMCS.

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

1. Log in to our client area and download the module.
CAP 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.4 and later.

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

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

PHP56 74 81.png
Note: You can check the current PHP version in your WHMCS. To do so, proceed to 'Utilities' → 'System' → 'PHP Info'.
3. Extract the package and upload its content into the main WHMCS directory.

The content of the package to upload should look like this.

CAP 2 1.png
4. When you install Client Area Popup For WHMCS for the first time you have to rename 'license_RENAME.php' file.

File is located in 'modules/addons/PopupModule/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

CAP 3.png
5. 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'.

CAP 4.png
6. Set permissions to file: 'modules/addons/PopupModule/templates/clientarea/assets/popup' to '0777'.
7. You will nedd to set up a cron job to assure automatic shifts of pop-ups' current statuses.
 php -q your_whmcs/modules/addons/PopupModule/cron/cron.php 

Note that the above directory is exemplary, please adjust the cron line to your own needs.

8. Now you have to activate the module in your WHMCS system.

Log in to your WHMCS admin area. Go to 'System Settings' 'Addon Modules'. Afterwards, find 'Client Area Popup' and press the 'Activate' button.

CAP 5.png
9. In the next step you need to permit access to this module.

To do so, click on 'Configure' button, tick 'Full Administrator' and press 'Save Changes'.

CAP 6.png
10. You have just successfully installed Client Area Popup For WHMCS!

You can access your module under 'Addons' 'Client Area Popup'.

CAP 7.png

Configuration and Management

Client Area Popup For WHMCS is a module which allows you to notify your clients by showing them customized pop-ups directly in their panel.

Below, you will find instructions on how to draft and customize such pop-ups.


The module does not require advanced configuration.
That is why, we will immediately move to the most crucial part, which is creating a pop-up.

Create Pop-up

To add a new pop-up simply press an appropriate button.
CAP 8.png


Start with naming the pop-up.

Note: The title will not be displayed in any way on the final pop-up.
If you added any pop-ups in the past, you may copy their settings to the newly created one to save time.
Note that the initial status of every new pop-up is 'Active'.

CAP 10.png

Look And Feel

The next part of creating a pop-up process concerns its interface, layout and general design.
  • Size

Auto - it automatically adjusts to the content.
Custom - if you want a customized size, then simply enter the appropriate width and height.

  • Animantion
    You may select the animation type among:
    • Fade In
    • Slide From Left
    • Slide From Right
    • Slide From Top
    • Slide From Bottom
    • Disable animations

When you select any, then enter the 'Animation Time ' to define how long it should last. Enter a required number of miliseconds.

  • Style

Select style from the list of available and previously defined styles.
More about styles can be found here.

CAP 11.png
  • Type

The pop-up may have a simple text form - select 'Text' and then format the text using the WYSIWYG editor.
See the visualization here.

CAP 12.png
Provide ready code snippet that you want to insert into the pop-up content.

See the visualization here.

CAP 13.png
Upload an 'Image'.

See the visualization here.

CAP 14.png


Restrictions - this is the place where a pop-up is conditioned. Please set up the rules according to which the pop-up will be displayed to clients.
Only one restriction rule per group is required to show the pop-up.
If you choose restrictions from multiple conditions then at least one rule in each group must be fulfilled to display the pup-up.

For example: If you choose three products under 'Has Active Product' rule then the client needs to have only one of active products to see the pop-up.
Let us say that you have chosen three products under 'Has Active Product' rule and three addons under 'Has Active Addon' rule.
In such a case the client will have to have at least one active product and at least one active addon from selected conditions to see the pop-up.

General options:
  • Display Frequency - define how often the pop-up will be displayed to a client, you may also make it visible all the time.
  • Hide Permanently - if selected, clients will be allowed to close the pop-up permanently, even if it was configured to appear repeatedly.
    • Disabled - clients are not allowed to hide a given pop-up permanently. Once closed, it will appear again if it has been configured such
    • Use a close button to hide permanently - pop-up when closed, will not appear again
    • Use a checkbox to hide permanently - when the checkbox is marked and pop-up closed with the close button, the pop-up will not appear again
  • Visible To Logged In Clients - if selected, the pop-up will be displayed to the logged in clients.
  • Visible To Not Logged In Clients - if selected, the pop-up will be displayed to all guests and unlogged visitors.
  • Invoice To Pay - display the pop-up to clients who have at least one unpaid invoice
  • Pages - provide here specific wildcards URL of sites where the pop-up should be available from. If you want your pop-up to appear on the main page, provide a slash mark /.
    Use a comma to separate them if you plan to add more than one page.
    e.g.: '*action=invoices, *action=quotes' etc.

Press required text area and available options will appear.

  • Days - show the pop-up on selected days only, if non selected, all days will be included by default
  • Languages - show the pop-up if a client uses one of the selected languages.
  • User Groups - show the pop-up if a client belongs to one of the selected groups.
  • Has Active Product - show the pop-up if a client has at least one active product from the selected ones.
  • Has Active Addon - show the pop-up if a client has at least one active addon from the selected ones.
  • Has Active Product In Group - show the pop-up if a client has active products in at least one of the selected groups. Note: At least one product in group is required.
  • Has Active TLD - show the pop-up if a client owns at least one active domain with one of the selected TLDs.
  • Has No Product - show the pop-up if a client does not own at least one active product from the selected ones.
  • Has No Addon - show the pop-up if a client does not own at least one active addon from the selected ones.
  • Has No TLD - show the pop-up if a client does not own at least one active domain with one of the selected TLDs.
  • Has Active Product In Group - show the pop-up if a client has at least one active product in the selected group of products.
  • Has Active Product With Server - show the pop-up if a client has at least one active product with one of the selected servers assigned.
  • URL Contains - Specify any phrase that the URL should contain to activate a pop-up after visiting the related link

If any of the above options is left blank (except 'Days' condition), it will not be taken into consideration when creating a final list of clients to see the pop-up.

CAP 15.png
You will also find there an explanation of the checking process:
CAP 16.png

Due Date Restrictions

In this section you may add restrictions basing on a selected service due date.
For example, if a due date of selected products/addons/domain for any of your clients is coming, you may create a popup that will appear a given number of days before the due date.
CAP 16 1.png
Select types:
  • Before Due Date
  • On Due Date
  • After Due Date

Then, select required conditions, you may choose more than one, they will be applied to the selected later on number.

  • Less Than
  • Equal To
  • Greater Than

Finally, type in the number basing on which a number of days to show the pop-up will be calculated.

CAP 16 2.png
Next, you will need to choose which of the active services or any services with the selected status will be checked.
CAP 16 3.png
As presented above, the pop-up will appear for clients who have active 'Test Product' and its due date is about to come.
The pop-up will be displayed for 10 days before the due date and on the due date.


In the last section, you can define the time period within which the pop-up is active - in other words, when it will be displayed with the set up previously frequency.
  • 'Start/End Date' - choose a specific day and hour to schedule the pop-up activation or select option 'Immediately' - then the pop-up will be active once you have saved the changes.
    Set up the ending date in the same way. Provide a specific date when the pop-up will be marked as 'Inactive'.
    You may also select 'Never' option if you do not want it to be deactivated.
  • 'Time Range' - specify exact time frames to show the pop-up, for example from 8 a.m. to 4 p.m.
    Keep in mind that this is the server time used here.
  • 'Delay Time' - if you enter here any value, then the pop-up will appear on the required page once mentioned here a number of seconds has passed,
    not immediately as the client enters the page.
  • 'Display Limit Per Client' - define how many times this pop-up can be displayed to a single client before being deactivated
  • 'Display Limit' - general limit of the pop-up displays, this limit, if provided, is taken as the first one when counting the views

Press 'Add' button once you have finished the configuration.

CAP 17.png


The first and main section of the module is called 'Pop-ups'.

You will find there all the most important information on existing pop-ups together with any possible action that can be taken on them.
Go through the following section to learn more.

CAP 19.png


1. Preview the pop-up - a sample page with a visible pop-up will appear. This is the final look a client receives.
2. Edit the pop-up - change the restrictions, timing or style.
3. Set the pop-up as inactive, it will be moved to 'Inactive' section.
4. Move the pop-up to archive, you will be able to restore it at any time in the future.
5. Delete the pop-up. You must be completely sure, you will not be able to have it back in any way.
6. You may also perform bulk actions on multiple selected entries simultaneously.

CAP 20.png


There are three types of pop-ups in the system:
  • Active
  • Inactive
  • Archived
CAP 21.png
Inactive pop-ups are those for which the end date has been exceeded and they are no longer displayed to clients.

Just like in case of active pop-ups all actions are available. You may edit it to change the end date and at the same time activate it again.

CAP 22.png
Pop-ups in archive are moved there manually or automatically, if you have set up the cron job (see point 7 of installation instruction), these can be the previously active or inactive pop-ups.

You may restore archived pop-ups any time and, depending on the end date of the resorted pop-up, it will be moved either to 'Active' or 'Inactive' group.

CAP 23.png


'Styles' section contains a list of all predefined styles that position your pop-ups.
There are 26 types of different styles that vary from one another with up or down position, right/left/center, overlay option etc.
CAP 24.png
Before you start using any of the styles you can see their preview in the client area.

See the visualization here.

CAP 24 2.png
If none of the predefined styles perfectly matches your needs, you may edit the styles.

Press the icon as marked on the screen.

CAP 25.png
You are moved to the style edition page with CSS and HTML details. You may edit them if you need to adjust the style to your preferences.
CAP 26.png

New Style

In case the predefined styles are not sufficient and you do not want to lose any by editing its content, you may always add a new style.
Press the button as on the screen to do so.
CAP 26 1.png
Provide your customized content or copy and modify a predefined style content.

Subsequently save the changes.

CAP 26 2.png


The last position in your navigation menu, when pressed, redirects to the article you are currently reading.
CAP 27.png


Now, let's take a look what Client Area Popup For WHMCS may give you in practice.
Underneath, you will find several examples of pup-ups, each in a different style and of a different type.
Settings sumamry to create the below pop-ups:

Look And Feel details:

  • Width: 'auto'
  • Style: 'center_popup_close_btn_2_overlay'
  • Type: 'Image'

Restrictions details:

  • Pages: clientarea.php

Note: 'Overlay' means there is a gray background behind the pop-up text or image.

CAP 31 1.png
Look And Feel details:
  • Width: 'auto'
  • Style: 'center_up_overlay'
  • Type: 'Text'

Restrictions details:

  • Pages: clientarea.php
CAP 29.png
Look And Feel details:
  • Width: 'auto'
  • Style: 'center'
  • Type: 'Image'

Restrictions details:

  • Hide Permanently: Use a checkbox to hide permanently
  • Pages: clientarea.php
CAP 30.png
Look And Feel details:
  • Width: 'auto'
  • Style: 'right_overlay_up'
  • Type: 'Image'

Restrictions details:

  • Hide Permanently: Use a checkbox to hide permanently
  • Pages: clientarea.php
CAP 31.png


1. For your comfort, 'HTML' type of pop-up content supports also 'JavaScript' to let you provide your preferable content.
2. The module is ad blocker resistant unless your clients block the popup class deliberately in the tool.

Update Instructions

Essential guidance through the process of updating the module is offered here.

Ensure successful completion of the module update by carefully following each step, thereby preventing data loss or any unforeseen issues.
Additionally, you will find a current list of supplementary actions necessary for a smooth update process there.

Upgrade Guide

Seeking a solution that offers greater flexibility, customization tailored to your precise needs, and unrestricted availability?
There is an option that not only proves to be cost-effective in the long run but also includes prioritized support services, making it a truly valuable investment.

Opt for the Open Source version of your Client Area Popup For WHMCS module to unlock these benefits.
Simply click on either the Get Source Code or Upgrade To Lifetime button found on the product's page in our client area to complete the one-step upgrade process, with a dedicated discount already applied.

Follow a comprehensive guide covering the transition process, the advantages it brings, and step-by-step instructions on what to do next after the order has been successfully finalized.

Common Problems

1. In case of connection problems, please check whether your SELinux or firewall does not block ports.
2. If you encounter an error like on the screen below, please make sure you have successfully completed step 6 of the installation instructions.
CAP 32.png
3. If you have problems with your license, please make sure that the content of the file is correct.

Please note that for Client Area Popup For WHMCS V1.0.1 and later the license key begins with:


Not as it was for the previous version:

4. The 'Display Limit' counter does not show a proper nomber of pop-up displays if you have an active admin session in your browser. Please log out from your admin account to perform any tests.
WHMCS Modules
WHMCS Widgets
cPanel Modules
Client Area Popup For WHMCS