Working With Client Area Home Page Panels - Revision history

SarahK: /* Interacting With Homepage Panels */

2022-06-23T18:44:25Z

‎Interacting With Homepage Panels

SarahK: /* Interacting With Homepage Panels */

2022-06-09T19:57:36Z

‎Interacting With Homepage Panels

SarahK: /* Interacting With Homepage Panels */

2022-05-31T15:10:24Z

‎Interacting With Homepage Panels

SarahK: /* Interacting With Homepage Panels */

2022-05-13T14:53:13Z

‎Interacting With Homepage Panels

SarahK: /* Interacting With Homepage Panels */

2022-05-13T14:17:30Z

‎Interacting With Homepage Panels

SarahK at 20:41, 11 May 2022

2022-05-11T20:41:49Z

SarahK at 20:29, 20 April 2022

2022-04-20T20:29:22Z

Show changes

PeterB: /* Examples */

2021-12-08T23:35:26Z

‎Examples

PeterM at 15:47, 5 October 2021

2021-10-05T15:47:28Z

AlexN: /* Default Panels */

2018-06-05T13:44:06Z

‎Default Panels

@@ Line 143: / Line 143: @@
 * The <tt>ClientAreaHomepagePanels</tt> hook allows you to manipulate the Client Area homepage's panels.
 ** Call this hook before you assign the panel object to the view template.
-** This hook passes the Client Area home panels' root item to the hook function.
+** This hook passes the Client Area home panel's root item to the hook function.
 * For more information about using the hook system and supported hook functions, see [https://developers.whmcs.com/hooks/ our Developer Documentation].
@@ Line 149: / Line 149: @@
 * Customers can invoke items from within the Client Area.
-* Use this to specfically add items to the '''Active Products/Services''' panel in the Client Area homepage.
+* Use this to specfically add items to the '''My Active Products/Services''' panel in the Client Area home page.
 * For more information on using custom actions, see [https://developers.whmcs.com/provisioning-modules/custom-actions/ our Developer Documentation].
 * You can also use this to add custom actions to [[Editing Client Area Menus|Client Area service sidebar menus]].

@@ Line 138: / Line 138: @@
 == Interacting With Homepage Panels ==
-−
 You can use WHMCS’ <tt>add_hook()</tt> function to call custom code when WHMCS is rendering homepage panels.
-−
 * The <tt>ClientAreaHomepagePanels</tt> hook allows you to manipulate the Client Area homepage's panels.
 ** Call this hook before you assign the panel object to the view template.
 ** This hook passes the Client Area home panels' root item to the hook function.
-* For more information about using the hook system and supported hook functions, see our [https://developers.whmcs.com/provisioning-modules/custom-actions/ Developer Documentation].
+* For more information about using the hook system and supported hook functions, see [https://developers.whmcs.com/hooks/ our Developer Documentation].
-−
 In WHMCS 8.5 and later, you can use the <tt>CustomActions</tt> server module function to define items that perform a set function and then redirect the user to a specified URL.
-−
 * Customers can invoke items from within the Client Area.
 * Use this to specfically add items to the '''Active Products/Services''' panel in the Client Area homepage.
 == Examples ==

@@ Line 146: / Line 146: @@
 * For more information about using the hook system and supported hook functions, see our [https://developers.whmcs.com/provisioning-modules/custom-actions/ Developer Documentation].
-You can use the <tt>CustomActions</tt> server module function to define items that perform a set function and then redirect the user to a specified URL.
+In WHMCS 8.5 and later, you can use the <tt>CustomActions</tt> server module function to define items that perform a set function and then redirect the user to a specified URL.
 * Customers can invoke items from within the Client Area.

@@ Line 144: / Line 144: @@
 ** Call this hook before you assign the panel object to the view template.
 ** This hook passes the Client Area home panels' root item to the hook function.
-* For more information about using the hook system and supported hook functions, see our [https://developers.whmcs.com/provisioning-modules/supported-functions/ Developer Documentation].
+* For more information about using the hook system and supported hook functions, see our [https://developers.whmcs.com/provisioning-modules/custom-actions/ Developer Documentation].
 You can use the <tt>CustomActions</tt> server module function to define items that perform a set function and then redirect the user to a specified URL.

@@ Line 139: / Line 139: @@
 == Interacting With Homepage Panels ==
-You can use the <tt>ClientAreaHomepagePanels</tt> hook to manipulate the Client Area homepage's panels.
+You can use WHMCS’ <tt>add_hook()</tt> function to call custom code when WHMCS is rendering homepage panels.
-* Call this hook before you assign the panel object to the view template.
+* The <tt>ClientAreaHomepagePanels</tt> hook allows you to manipulate the Client Area homepage's panels.
-* This hook passes the Client Area home panels' root item to the hook function.
+** Call this hook before you assign the panel object to the view template.
-Use WHMCS’ <tt>add_hook()</tt> function to call custom code when WHMCS is ready to render these panels.
+You can use the <tt>CustomActions</tt> server module function to define items that perform a set function and then redirect the user to a specified URL.
 == Examples ==

@@ Line 19: / Line 19: @@
 === Desktop Mode ===
-[[Image:85DesktopClientPanels.png|thumb|The WHMCS 8.5 Client Area homepage panel layout in desktop mode]] When viewed in desktop mode, typically on desktop web browsers, most client area homepage panels render in two columns. In WHMCS 8.5 and later, it is also possible to create panels that span both columns.
+[[Image:85DesktopClientPanels.png|thumb|The WHMCS 8.5 Client Area homepage panel layout in desktop mode]] When viewed in desktop mode, typically on desktop web browsers, most client area homepage panels render in two columns. In [[Version 8.5 Release Notes|WHMCS 8.5 and later]], it is also possible to create panels that span both columns.
 * For single-column panels, odd numbered panels are rendered on the left column and even numbered panels are rendered on the right column.

@@ Line 159: / Line 159: @@
 use Carbon\Carbon;
-use WHMCS\User\Client;
+use WHMCS\Authentication\CurrentUser;
 use WHMCS\View\Menu\Item;
@@ Line 165: / Line 165: @@
+{
      /** @var \WHMCS\User\Client $currentUser */
-     $currentUser = Client::find($_SESSION['uid']);
+     $currentUser = CurrentUser::client();
      $today = Carbon::now()->startOfDay();

@@ Line 151: / Line 151: @@
 # Move the local temperatures to the beginning so it's displayed first.
-Create the <tt>includes/hooks/clientWeatherPanel.php</tt> file in your WHMCS installation and enter the code below. WHMCS will parse the file and hook on page load and will run the hook function when the client visits the home page after logging in.
+Create the <tt>includes/hooks/clientWeatherPanel.php</tt> file in your WHMCS installation and enter the code below. WHMCS will parse the file and hook when the page loads and will run the hook function when the client visits the home page after logging in.
 <div style="clear: both"></div>
@@ Line 229: / Line 229: @@
 # Set the order to 20 to place it after the default unpaid and overdue invoice panels.
-Create the <tt>includes/hooks/specialOfferPanel.php</tt> file in your WHMCS installation and enter the code below. As with the previous example, WHMCS will parse the file and hook on page load and will run the hook function when the client visits the home page after logging in.
+Create the <tt>includes/hooks/specialOfferPanel.php</tt> file in your WHMCS installation and enter the code below. As with the previous example, WHMCS will parse the file and hook when the page loads and will run the hook function when the client visits the home page after logging in.
 <div style="clear: both"></div>
@@ Line 267: / Line 267: @@
 Another common item is to want to change a link button and its text in a home panel panel (for example: if you want to link to a third party ticket system you already have in place.
-Create the <tt>includes/hooks/recentTicketsPanel.php</tt> file in your WHMCS installation and enter the code below. As with the previous example, WHMCS will parse the file and hook on page load and will run the hook function when the client visits the home page after logging in.
+Create the <tt>includes/hooks/recentTicketsPanel.php</tt> file in your WHMCS installation and enter the code below. As with the previous example, WHMCS will parse the file and hook when the page loads and will run the hook function when the client visits the home page after logging in.
 <div style="clear: both"></div>
@@ Line 292: / Line 292: @@
+             ]
          );
+     }
 });
 </syntaxhighlight>

@@ Line 91: / Line 91: @@
 | 50
 | Manage Domains
-| At least one domain expiring within 30 days
+| At least one domain expiring within 45 days
 |-
 | Active Products/Services