---
title: "How to Create a Custom Page for WHMCS"
description: "In This Tutorial: Create PHP File Add PHP Code Create Template File Add HTML Code WHMCS is a system designed to automate and manage many common web hosting tasks for resellers. For instance, WHMCS..."
url: https://www.inmotionhosting.com/support/edu/whm/how-to-create-a-custom-page-for-whmcs/
date: 2018-04-10
modified: 2022-02-14
author: "InMotion Hosting Contributor"
categories: ["WebHost Manager (WHM)"]
type: post
lang: en
---
# How to Create a Custom Page for WHMCS
## In This Tutorial:
[Create PHP File](#create-php-file) [Add PHP Code](#add-php-code) [Create Template File](#create-tpl-file) [Add HTML Code](#add-html-code)
WHMCS is a system designed to automate and manage many common web hosting tasks for resellers. For instance, WHMCS can handle the point of sale, billing, and setup of a new account, including provisioning it on the server.
WHMCS creates pages based on the modules that are installed and the functions that are enabled by the administrator/webmaster. If you want to create a unique *client area* page, you can manually *create the necessary .php* and *.tpl* files to build a custom page. By completing this guide, you can learn **how to create a custom page that is compatible with WHMCS.**
## Create a PHP (.php) File
First, a *.php* file needs to be created. This file will reside in your WHMCS root directory.
**NOTE:** If you are unsure of the location of your WHMCS installation, click the button below for additional help.
Find Your WHMCS Directory
### How to Locate Your WHMCS Root Directory
To locate your WHMCS directory root directory, [find the document root directory](/support/website/where-to-upload-files/) for your domain. If your WHMCS root directory is also the document root directory for your website (ie. you access the website using just your domain `https://www.example.com/`), then you should see the following directories inside of your document root directory for your domain:
- admin
- assets
- attachments
- downloads
- feeds
- inclues
- lang
- modules
- oauth
- pipe
- resources
- status
- templates
- templates_c
- vendor
**Still unsure?** The WHMCS directory will also include many *.php* files. Try openning a few *.php* files. You can identify files related to WHMCS by comparing the first few lines in the file with the code similar to the following example:
setPageTitle('Your Page Title Goes Here'); $ca->addToBreadCrumb('index.php', Lang::trans('globalsystemname')); $ca->addToBreadCrumb('mypage.php', 'Your Custom Page Name'); $ca->initPage(); //$ca->requireLogin(); // Uncomment this line to require a login to access this page // To assign variables to the template system use the following syntax. // These can then be referenced using {$variablename} in the template. //$ca->assign('variablename', $value); // Check login status if ($ca->isLoggedIn()) { /** * User is logged in - put any code you like here * * Here's an example to get the currently logged in clients first name */ $clientName = Capsule::table('tblclients') ->where('id', '=', $ca->getUserID())->pluck('firstname'); // 'pluck' was renamed within WHMCS 7.0. Replace it with 'value' instead. // ->where('id', '=', $ca->getUserID())->value('firstname'); $ca->assign('clientname', $clientName); } else { // User is not logged in $ca->assign('clientname', 'Random User'); } /** * Set a context for sidebars * * @link https://docs.whmcs.com/Editing_Client_Area_Menus#Context */ Menu::addContext(); /** * Setup the primary and secondary sidebars * * @link https://docs.whmcs.com/Editing_Client_Area_Menus#Context */ Menu::primarySidebar('announcementList'); Menu::secondarySidebar('announcementList'); # Define the template filename to be used without the .tpl extension $ca->setTemplate('mypage'); $ca->output();
6. Click on the **Save Changes** button.
## Create a Template (.tpl) File
Now that you have created the necessary *.php* file, you can create a *.tpl* file. This file will be where you can *save your HTML to design the custom page* you are creating for WHMCS. In this section, you can learn how to *create the necessary .tpl file* to **design a custom page in WHMCS**.
1. [Log into your reseller cPanel](/support/edu/cpanel/how-to-log-into-cpanel/).
2. Click on the **File Manager** icon.
3. Navigate to the following directory inside of your [WHMCS root directory](#find-whmcs-root-dir): **templates/*name-of-template/*/** **NOTE:** Be sure to replace *name-of-template/* with the actual directory name for your active template.
4. Click the **File** button.
5. In the pop-up, enter the name you would like to give to the file, for example `mypage.tpl` into the field **New File Name:**.
6. Click the **Create New File** button.
## Add HTML
Once you have a *.tpl* file and a *.php* file for your **custom page**, you may begin *desiging the page using HTML*. In this section, you can learn how to *add the HTML to your .tpl file* and *preview your page in your web browser*.
1.
1. [Log into your reseller cPanel](/support/edu/cpanel/how-to-log-into-cpanel/).
2. Click on the **File Manager** icon.
3. Navigate to the following directory inside of your [WHMCS root directory](#find-whmcs-root-dir): **templates/*name-of-template/*/** **NOTE:** Be sure to replace *name-of-template/* with the template’s directory name for your active template.
4. Right-click on the *.tpl* file you created and select **Edit**. **NOTE:** If a pop-up is displayed regarding the encoding of the file, simply click the **Edit** button to proceed to open the file with the default encoding.
5. Now enter your HTML. For example: This is my custom WHMCS page's content
I used the code found here.
I put that code into a file named:
mypage.php, which resides in the root directory (where my WHMCS is installed).
Now, I can write HTML into the file named:
mypage.tpl, located in the templates/six/ directory. Any HTML I save into that file, will be displayed on my new custom page.
6. Once you have entered your code, click on the **Save Changes** button.
Once you have saved the *.tpl* file with the code you would like (or using our example data), you can *visit the URL for that page from your web browser*. Simply open your browser and visit the following URL (example format):
`https://www.example.com/whmcs/mypage.php`
**NOTE:** Be sure to replace `https://www.example.com/whmcs` with your actual domain (and path) to your [WHMCS root directory](#find-whmcs-root-dir). Additionally, be sure to change `mypage.php` to the actual name of the *.php* file you created (not the *.tpl* file).
**Congratulations!** You now know how to **create a custom page** to use with your **WHMCS** installation.