Difference between revisions of "Creating Pages"

From WHMCS Documentation
m (Reverted edits by Matt (talk) to last revision by Nicolas)
Line 1: Line 1:
 +
Creating your own custom pages for WHMCS is simple. Use this to extend the client area. For example, building the whole site around WHMCS, or creating custom pages to provide extra functionality to clients.
 +
 
==Standard Page==
 
==Standard Page==
  
Line 59: Line 61:
  
 
*How to initiate the page
 
*How to initiate the page
 +
*How to force the page to use SSL (FORCESSL)
 
*How to reference the language file variables (Lang::trans)
 
*How to reference the language file variables (Lang::trans)
 
*How to check if a user is logged in ($ca->isLoggedIn())
 
*How to check if a user is logged in ($ca->isLoggedIn())
Line 66: Line 69:
 
The template file should be a filename in the active WHMCS system template folder. So, for the example above the path would be /templates/default/mypage.tpl.
 
The template file should be a filename in the active WHMCS system template folder. So, for the example above the path would be /templates/default/mypage.tpl.
  
−
Now when ready to test, upload the PHP file to the root WHMCS directory and the template file to your active template directory. Then visit the PHP file in your browser to try it.
+
Now when ready to test, upload both the PHP and TPL file to the appropriate folders. Then visit the PHP file in the root WHMCS directory to run.
 +
 
 +
==Page with a Sidebar==
 +
It is possible to define a [[Editing_Client_Area_Menus|sidebar]] display on a custom page. The following shows how to create a custom page, and also define a sidebar to display alongside. It demonstrates:
 +
 
 +
*How to set contact for the sidebar, thereby influencing what data passes to the menu
 +
*How to define both the primary and secondary sidebars for display
 +
 
 +
<source lang="php">
 +
<?php
 +
 
 +
use WHMCS\ClientArea;
 +
use WHMCS\Database\Capsule;
 +
 
 +
 
 +
define('CLIENTAREA', true);
 +
//define('FORCESSL', true); // Uncomment to force the page to use https://
 +
 
 +
require __DIR__ . '/init.php';
 +
 
 +
$ca = new ClientArea();
 +
 
 +
$ca->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 http://docs.whmcs.com/Editing_Client_Area_Menus#Context
 +
*/
 +
Menu::addContext();
 +
 
 +
/**
 +
* Setup the primary and secondary sidebars
 +
*
 +
* @link http://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();
 +
</source>
 +
 
  
−
<div class="docs-alert-info">Custom pages created in this way should always be located in the root WHMCS directory. Attempting to use this code outside of the root directory may lead to issues and is unsupported.</div>
+
{{Developer_Links}}

Revision as of 16:17, 15 October 2016

Creating your own custom pages for WHMCS is simple. Use this to extend the client area. For example, building the whole site around WHMCS, or creating custom pages to provide extra functionality to clients.

Standard Page

To get started, copy & paste the code below into a new PHP file and save it in the main WHMCS directory. 

<?php

use WHMCS\Database\Capsule;

define("CLIENTAREA", true);
//define("FORCESSL", true); // Uncomment to force the page to use https://

require("init.php");

$ca = new WHMCS_ClientArea();

$ca->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

}

# Define the template filename to be used without the .tpl extension

$ca->setTemplate('mypage');

$ca->output();

This example above shows you the required layout of a custom page. It demonstrates:

  • How to initiate the page
  • How to force the page to use SSL (FORCESSL)
  • How to reference the language file variables (Lang::trans)
  • How to check if a user is logged in ($ca->isLoggedIn())
  • How to define template variables ($ca->assign)
  • How to set the template to use and then output it

The template file should be a filename in the active WHMCS system template folder. So, for the example above the path would be /templates/default/mypage.tpl.

Now when ready to test, upload both the PHP and TPL file to the appropriate folders. Then visit the PHP file in the root WHMCS directory to run.

Page with a Sidebar

It is possible to define a sidebar display on a custom page. The following shows how to create a custom page, and also define a sidebar to display alongside. It demonstrates:

  • How to set contact for the sidebar, thereby influencing what data passes to the menu
  • How to define both the primary and secondary sidebars for display
<?php

use WHMCS\ClientArea;
use WHMCS\Database\Capsule;


define('CLIENTAREA', true);
//define('FORCESSL', true); // Uncomment to force the page to use https://

require __DIR__ . '/init.php';

$ca = new ClientArea();

$ca->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 http://docs.whmcs.com/Editing_Client_Area_Menus#Context
 */
Menu::addContext();

/**
 * Setup the primary and secondary sidebars
 *
 * @link http://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();


Developer Resources
Provisioning Module Docs] | Gateway Module Docs] | Registrar Module Docs] | Addon Modules
Template Syntax | Database Interactions | Addon Modules | Creating Pages | Action Hooks] | API
Retrieved from "http://3.17.75.209/index.php?title=Creating_Pages&oldid=20586"