Creating Pages - Revision history

Matt: Replaced content with "For the latest recommend method for creating pages, please visit https://developers.whmcs.com/advanced/creating-pages/"

2017-01-28T18:14:20Z

Replaced content with "For the latest recommend method for creating pages, please visit https://developers.whmcs.com/advanced/creating-pages/"

Matt: /* Standard Page */

2016-10-15T16:19:05Z

‎Standard Page

Matt: Reverted edits by Matt (talk) to last revision by Nicolas

2016-10-15T16:17:17Z

Reverted edits by Matt (talk) to last revision by Nicolas

Matt at 16:09, 15 October 2016

2016-10-15T16:09:14Z

Nicolas: /* Page with a Sidebar */

2016-07-11T17:01:31Z

‎Page with a Sidebar

Nicolas: /* Standard Page */

2016-07-11T17:00:35Z

‎Standard Page

Andrew at 11:03, 5 January 2016

2016-01-05T11:03:28Z

Andrew: /* Page with a Sidebar */

2016-01-05T11:03:00Z

‎Page with a Sidebar

Andrew: /* Standard Page */

2016-01-05T11:00:38Z

‎Standard Page

Andrew: /* Standard Page */

2016-01-05T10:58:43Z

‎Standard Page

← Older revision		Revision as of 18:14, 28 January 2017
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.~~	+	For the latest recommend method for creating pages, please visit https://developers.whmcs.com/advanced/creating-pages/
−
−	~~==Standard Page==~~
−
−	~~To get started, copy & paste the code below into a new PHP file and save it in the main WHMCS directory.~~
−
−	~~<source lang="php">~~
−	~~<?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();~~
−	~~</source>~~
−
−	~~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 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.~~
−
−	<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>
−
−	~~==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>~~
−
−
−	~~{{Developer_Links}}~~

@@ Line 69: / 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.
-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.
+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.
 ==Page with a Sidebar==

@@ Line 1: / Line 1: @@
 ==Standard Page==
@@ Line 59: / Line 61: @@
 *How to initiate the page
 *How to reference the language file variables (Lang::trans)
 *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.
-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.
-<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}}

@@ Line 1: / Line 1: @@
 ==Standard Page==
@@ Line 61: / Line 59: @@
 *How to initiate the page
 *How to reference the language file variables (Lang::trans)
 *How to check if a user is logged in ($ca->isLoggedIn())
@@ Line 69: / Line 66: @@
 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.
+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.
-{{Developer_Links}}
+<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>

@@ Line 116: / Line 116: @@
      $clientName = Capsule::table('tblclients')
          ->where('id', '=', $ca->getUserID())->pluck('firstname');
      $ca->assign('clientname', $clientName);

@@ Line 41: / Line 41: @@
        ->where('id', '=', $ca->getUserID())->pluck('firstname');
-   $ca->assign('clientname', $clientname);
+   $ca->assign('clientname', $clientName);
 } else {

@@ Line 70: / Line 70: @@
 ==Page with a Sidebar==
-In version v6.0 and later is it possible to define a [[Editing_Client_Area_Menus|sidebar]] to be displayed on the custom page. The following example shows how to create a custom page as above, and also define a sidebar to be displayed alongside, it demonstrates:
+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 is passed to the menu
+*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
@@ Line 79: / Line 79: @@
 use WHMCS\ClientArea;
-use Illuminate\Database\Capsule\Manager as Capsule;
+use WHMCS\Database\Capsule;
@@ Line 112: / Line 112: @@
       */
-     $client = Capsule::table('tblclients')->where('id', $ca->getUserID())->first();
+     $clientName = Capsule::table('tblclients')
-     $ca->assign('clientname', $client->firstname);
+        ->where('id', '=', $ca->getUserID())->pluck('firstname');
 } else {

@@ Line 38: / Line 38: @@
    # Here's an example to get the currently logged in clients first name
-   $clientName = Capsule::table('tblclients')->where('id', '=', $ca->getUserID())->pluck->('firstname');
+   $clientName = Capsule::table('tblclients')
    $ca->assign('clientname', $clientname);

@@ Line 3: / Line 3: @@
 ==Standard Page==
-To get started, simply copy & paste the code below into a new PHP file and save it in the main WHMCS directory.
+To get started, copy & paste the code below into a new PHP file and save it in the main WHMCS directory.
 <source lang="php">
 <?php
 define("CLIENTAREA", true);
@@ Line 19: / Line 19: @@
 $ca->setPageTitle("Your Page Title Goes Here");
-$ca->addToBreadCrumb('index.php', $whmcs->get_lang('globalsystemname'));
+$ca->addToBreadCrumb('index.php', Lang::trans('globalsystemname'));
 $ca->addToBreadCrumb('mypage.php', 'Your Custom Page Name');
@@ Line 38: / Line 38: @@
    # Here's an example to get the currently logged in clients first name
-   $result = mysql_query("SELECT firstname FROM tblclients WHERE id=" . $ca->getUserID());
+   $clientName = Capsule::table('tblclients')->where('id', '=', $ca->getUserID())->pluck->('firstname');
    $ca->assign('clientname', $clientname);
@@ Line 61: / Line 59: @@
 *How to initiate the page
 *How to force the page to use SSL (FORCESSL)
-*How to reference the language file variables ($whmcs->get_lang)
+*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)
-*And how to set the template to use and then output it
+*How to set the template to use and then output it
-The template file you define should be a filename in your 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 you're ready to test, upload both the PHP and TPL file to the appropriate folders and then visit the PHP file in the root WHMCS directory to run.
+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==