Client Area Sidebars Cheatsheet - Revision history

SarahK: /* Adding an Additional Sidebar Menu Item */

2022-06-09T19:57:15Z

‎Adding an Additional Sidebar Menu Item

2021-07-13T13:27:51Z

‎Adding an Additional Sidebar Menu Item

2021-05-13T11:26:35Z

Added green info box at top

2020-12-01T21:26:14Z

‎Finding a Sidebar Name

2020-12-01T21:24:26Z

‎Finding a Sidebar Name

2019-06-18T06:11:08Z

2018-09-25T12:27:27Z

‎Hiding/Removing a Sidebar Menu Item

2018-09-25T12:26:26Z

‎Hiding/Removing a Sidebar Menu Item

2017-04-25T13:50:59Z

‎Manipulate a Sidebar Menu Item by Name

2017-04-25T13:29:21Z

@@ Line 87: / Line 87: @@
 ==Adding an Additional Sidebar Menu Item==
-−
-To add an additional item to a menu, we must first check that the sidebar exists on the particular page before speciying  You can add additional menu items as follows:
+Before adding an item to a menu, check that the sidebar exists on that specific page. You can then add more menu items using code like the following example:
-−
 <source lang="php">
 <?php
-−
 use WHMCS\View\Menu\Item as MenuItem;
 add_hook('ClientAreaPrimarySidebar', 1, function (MenuItem $primarySidebar)
-−
+{
-	if (!is_null($primarySidebar->getChild('My Account'))) {
+    if (!is_null($primarySidebar->getChild('My Account'))) {
-		$primarySidebar->getChild('My Account')
+        $primarySidebar->getChild('My Account')
-	->addChild('Mailing List Subscription Prefs')
+    ->addChild('Mailing List Subscription Prefs')
-		->setLabel('Subscription Preferences')
+        ->setLabel('Subscription Preferences')
-		->setUri('subscriptionprefs.php')
+        ->setUri('subscriptionprefs.php')
-		->setIcon('fa-user')
+        ->setIcon('fa-user')
-		->setOrder(100);
+        ->setOrder(100);
-−
+    }
 });
 </source>
 ==Hiding/Removing a Sidebar Menu Item==

@@ Line 102: / Line 102: @@
 		->setLabel('Subscription Preferences')
 		->setUri('subscriptionprefs.php')
 		->setOrder(100);
+	}

@@ Line 1: / Line 1: @@
 The following guide is designed to provide some copy & paste ready code samples for common customisations performed to the dynamic sidebar menus.  For more detailed documentation, please refer to [[Editing Client Area Menus]]
-This guide assumes you are already familiar with [https://developers.whmcs.com/hooks/ creating and using Hook files in WHMCS].
+<div class="docs-alert-success"><strong>Important</strong><br>This guide assumes you are already familiar with [https://developers.whmcs.com/hooks creating and using hook files in WHMCS].  The following code examples will need to be placed within a [https://developers.whmcs.com/hooks/getting-started/ hook file].</div>
 ==Finding a Sidebar Name==

@@ Line 7: / Line 7: @@
 Every sidebar menu item has a unique name that is used to reference it.  You will need this name in order to manipulate it.  To make it easier, we have made the name of each sidebar menu item available in the HTML source of the page, which means it can be retrieved using the Inspect Element option available in most modern browsers.  An example of this is shown below.
-[[File:menus-find-name.png]]
+[[File:menus-find-name.png|700px]]
 Once you have the menu item name that you wish to manipulate, which in the example above is '''Account Details''' you can manipulate it in the following ways.

@@ Line 7: / Line 7: @@
 Every sidebar menu item has a unique name that is used to reference it.  You will need this name in order to manipulate it.  To make it easier, we have made the name of each sidebar menu item available in the HTML source of the page, which means it can be retrieved using the Inspect Element option available in most modern browsers.  An example of this is shown below.
-[[File:Finding_a_Sidebar.png]]
+[[File:menus-find-name.png]]
-Once you have the menu item name that you wish to manipulate, which in the example above is "Billing Information" you can manipulate it in the following ways.
+Once you have the menu item name that you wish to manipulate, which in the example above is '''Account Details''' you can manipulate it in the following ways.
-<div class="docs-alert-info">The client area's sidebar menu system is defined in a tree structure. Each menu item has one parent item and can have many child items. So when you're looking to manipulate a menu item within a sidebar panel, you will need to first retrieve the parent menu item, which in the case above is "My Account", followed by the "Billing Information" menu item which is a child within that.</div>
+<div class="docs-alert-info">
 ==Changing the Text Label of a Sidebar Item==

@@ Line 117: / Line 117: @@
+{
      if(!is_null($primarySidebar->getChild('My Account')) && !is_null($primarySidebar->getChild('My Account')->getChild('Billing Information'))){
-     $primarySidebar->getChild('My Account')
+     $primarySidebar->getChild('My Account')->removeChild('Billing Information');
+     }
 });

@@ Line 124: / Line 124: @@
 ==Manipulate a Sidebar Menu Item by Name==
-You can also manipulate a menu item by name with the '''ClientAreaSidebars''' hook point. The following code would check to see which sidebar the element belongs to, and then allow you to act on it as follows:
+You can also manipulate a menu item by name with the '''ClientAreaSidebars''' hook point. The following code would check to see which sidebar the element belongs to, and then allow you to act on it. In this example by removing it:
 <source lang="php">