Editing Client Area Menus - Revision history

James.white: /* Context */

2023-03-07T14:40:10Z

‎Context

SarahK at 14:13, 28 December 2022

2022-12-28T14:13:56Z

Show changes

SarahK: /* Move the “Contact Us” link to the secondary navigation bar and add more contact options */

2022-06-24T20:39:46Z

‎Move the “Contact Us” link to the secondary navigation bar and add more contact options

SarahK: /* Add a special offer image and link to the top of the topmost sidebar */

2022-06-24T19:41:10Z

‎Add a special offer image and link to the top of the topmost sidebar

SarahK: /* Hooks */

2022-06-09T19:56:27Z

‎Hooks

SarahK at 20:56, 14 October 2021

2021-10-14T20:56:24Z

SarahK at 20:55, 14 October 2021

2021-10-14T20:55:18Z

DanR: /* Add a special offer image and link to the top of the topmost sidebar */

2021-03-09T14:29:15Z

‎Add a special offer image and link to the top of the topmost sidebar

Nathan: /* Add a social media panel to the end of the sidebar */

2020-11-24T22:46:45Z

‎Add a social media panel to the end of the sidebar

Nathan: /* Add a social media panel to the end of the sidebar */

2020-11-24T22:35:38Z

‎Add a social media panel to the end of the sidebar

@@ Line 376: / Line 376: @@
 ** The id number of the ticket the user is viewing.
 |-
 |}

@@ Line 484: / Line 484: @@
 ==Move the “Contact Us” link to the secondary navigation bar and add more contact options==
-[[Image:Custom navbar menu highlighted.png|thumb|The WHMCS 6 client area navbars with the Contact Us link moved to the secondary navbar with a custom dropdown menu.]] The graphic designer feels that our awesome hosting company’s WHMCS installation will more closely match the main site if the “Contact Us” link is moved to the right hand side of the installation’s navigation bars before the “Account” link. They also want a dropdown under the link with links specifically to email the sales team, call us, and provide a map to the company via Google Maps.
+[[Image:Custom navbar menu highlighted.png|thumb|The WHMCS Six Theme Client Area navbars with the Contact Us link moved to the secondary navigation bar with a custom menu.]] The graphic designer feels that our awesome hosting company’s WHMCS installation will more closely match the main site if the “Contact Us” link is moved to the right hand side of the installation’s navigation bars before the “Account” link. They also want a dropdown under the link with links specifically to email the sales team, call us, and provide a map to the company via Google Maps.
-This example requires manipulating more than one menu bar. To do that we’ll use the '''ClientAreaNavbars''' hook and the <tt>Menu</tt> class to retrieve the primary and secondary navigation bars. We’ll use the menu item’s <tt>getChild()</tt>, <tt>removeChild()</tt>, <tt>addChild()</tt>, and <tt>moveToFront()</tt> methods and the static <tt>Menu::primaryNavbar()</tt> and <tt>Menu::secondaryNavbar()</tt> methods. Here’s what we’ll do:
+This example for the Six theme (but not Twenty-One) requires manipulating more than one menu bar. To do that we’ll use the '''ClientAreaNavbars''' hook and the <tt>Menu</tt> class to retrieve the primary and secondary navigation bars. We'll use the menu item's <tt>getChild()</tt>, <tt>removeChild()</tt>, <tt>addChild()</tt>, and <tt>moveToFront()</tt> methods and the static <tt>Menu::primaryNavbar()</tt> and <tt>Menu::secondaryNavbar()</tt> methods. Here’s what we’ll do:
 # Save the “Contact Us” link from the primary navigation bar.

@@ Line 443: / Line 443: @@
 ==Add a special offer image and link to the top of the topmost sidebar==
-[[Image:Custom panel body html highlighted.png|thumb|The WHMCS 6 client area announcements sidebar panel with a custom special offer highlighted.]] Your web host is doing amazing and to celebrate is offering a discount to all users. The marketing folks want a small image and message in the top of the first sidebar panel on every page that links to a page with the special offer.
+[[Image:Custom panel body html highlighted.png|thumb|A Client Area panel displaying a custom special offer.]] Your web host is doing amazing and to celebrate is offering a discount to all users. The marketing folks want a small image and message in the top of the first sidebar panel on every page that links to a page with the special offer.
 This example uses the '''ClientAreaPrimarySidebar''' hook and the menu item’s <tt>getFirstChild()</tt> and <tt>setBodyHtml()</tt> methods. To add panel with links to the sidebar we must:

@@ Line 114: / Line 114: @@
 ** Called prior to rendering sidebars.
 ** Passes no parameters to the hook function
 ==Direct Access==

@@ Line 176: / Line 176: @@
 * ''[http://docs.whmcs.com/classes/7.1/WHMCS/User/Client.html \WHMCS\User\Client]|null'': '''client'''
 ** The client currently logged in, or <tt>null</tt> if no client is logged in.
-* ''[[collection]] of [http://docs.whmcs.com/classes/7.1/WHMCS/User/Client/SecurityQuestion.html \WHMCS\User\Client\SecurityQuestion]'': '''securityQuestions'''
+* <nowiki>''[[collection]] of [http://docs.whmcs.com/classes/7.1/WHMCS/User/Client/SecurityQuestion.html \WHMCS\User\Client\SecurityQuestion]'': '''securityQuestions'''</nowiki>
 ** The configured system security questions.
 |-
@@ Line 230: / Line 230: @@
 * ''[http://docs.whmcs.com/classes/7.1/WHMCS/User/Client.html \WHMCS\User\Client]|null'': '''client'''
 ** The client currently logged in, or <tt>null</tt> if no client is logged in
-* ''[[collection]] of [http://docs.whmcs.com/classes/7.1/WHMCS/Download/Download.html \WHMCS\Download\Download]'': '''topFiveDownloads'''
+* <nowiki>''[[collection]] of [http://docs.whmcs.com/classes/7.1/WHMCS/Download/Download.html \WHMCS\Download\Download]'': '''topFiveDownloads'''</nowiki>
 ** The five most downloaded files that are not hidden or in a hidden download category, ordered by number of downloads in descending order.
 * ''[http://docs.whmcs.com/classes/7.1/WHMCS/Download/Category.html \WHMCS\Download\Category]'': '''downloadCategory'''
@@ Line 258: / Line 258: @@
 * ''[http://docs.whmcs.com/classes/7.1/WHMCS/User/Client.html \WHMCS\User\Client]|null'': '''client'''
 ** The client currently logged in, or <tt>null</tt> if no client is logged in.
-* ''[[collection]] of [http://docs.whmcs.com/classes/7.1/WHMCS/Product/Group.html \WHMCS\Product\Group]'': '''productGroups'''
+* <nowiki>''[[collection]] of [http://docs.whmcs.com/classes/7.1/WHMCS/Product/Group.html \WHMCS\Product\Group]'': '''productGroups'''</nowiki>
 ** A WHMCS installation's configured product groups.
 * ''int'': '''productGroupId'''

@@ Line 161: / Line 161: @@
 * ''[http://docs.whmcs.com/classes/7.1/WHMCS/User/Client.html \WHMCS\User\Client]|null'': '''client'''
 ** The client currently logged in, or <tt>null</tt> if no client is logged in
-* ''[[collection]] of [https://github.com/briannesbitt/Carbon \Carbon\Carbon]'': '''monthsWithAnnouncements'''
+* <nowiki>''[[collection]] of [https://github.com/briannesbitt/Carbon \Carbon\Carbon]'': '''monthsWithAnnouncements'''</nowiki>
 ** The past ten months in which announcements have been published.
 |-

@@ Line 451: / Line 451: @@
 <syntaxhighlight lang="php">
 <?php
 use WHMCS\View\Menu\Item as MenuItem;
-−
 add_hook('ClientAreaPrimarySidebar', 1, function (MenuItem $primarySidebar)
+{
@@ Line 463: / Line 462: @@
 </a>
 EOT;
-−
-     // Add a link to the special to the first panel's body HTML. It will render
+    if($primarySidebar->count() > 0)
-    // above the panel's menu item list.
-    $firstSidebar = $primarySidebar->getFirstChild();
-    if ($firstSidebar) {
+         // Add a link to the special to the first panel's body HTML. It will render
      	$firstSidebar->setBodyHtml($specialOfferHtml);
+     }
 });
 </syntaxhighlight>

@@ Line 377: / Line 377: @@
 ==Add a social media panel to the end of the sidebar==
-[[Image:social-media-sidebar.png|thumb|The Client Area supports a secondary sidebar with a custom social media panel highlighted.]]
+[[Image:Custom social media sidebar panel.png|thumb|The Client Area supports a secondary sidebar with a custom social media panel highlighted.]]
 You may want to better connect with your clients by using social media. The menu hooks in WHMCS 6.0 and later allow you to insert links to your company’s Facebook, Twitter, and other social media profiles directly into the interface. We recommend putting them at the end of the secondary sidebar so they’re rendered last and won’t interrupt your users’ experience.

@@ Line 408: / Line 408: @@
          'label' => 'Social Media',
          'uri' => '#',
-         'icon' => 'fas fa-thumbs-up fa-fw',
+         'icon' => 'fas fa-thumbs-up',
      ));