Table of Contents
Switching to the My Account Home Page Introduced in v4
As of version 4.0.0RC11, the My Account Home page (formerly the User Management Home Page) has been completely re-done. Clean installs of 4.0RC11 and later will use the new page by default, but those upgrading from older versions will need to manually switch over, if they desire to do so.
This page of the manual will attempt to elucidate on the new functions and explain how to go about switching to the new My Account Home page.
Overview
There are three elements to the new My Account page, all added after the final 4.0 release:
- A new module {module tag='my_account_links'}
- A new template (Basic Page Template with My Account Links)
- A new page (My Account Page)
In short, instructions for using the new features are:
- Switch the My Account Home Type setting to "My Account Page". Look to the following new admin tool page and look for the following switch:
- SITE SETUP > USER ACCOUNT SETTINGS > MY ACCOUNT HOME TYPE
- There should already be a user_management_page.tpl template within your system now. If changing the above setting doesn't automatically make the change within your client side home page you will need to create a page template specifically for the user management home page or you can modify the template already attached there. If you need to modify the current template attached to that page just make sure that page template contains the "{module tag='my_account_links'}" template where you want that module to appear in the design of that page and that page contains the "{body_html}" tag (where you want it to appear) and "{header_html}" tag (where it needs to appear in the <head>..</head>). Once you have the elements in the page you can see what is displayed by each and adjust the template design as you want.
- Make sure the template created for the user management home page is attached to the following page in the admin tool.
- PAGES MANAGEMENT > USER MANAGEMENT > MY ACCOUNT HOME PAGE
If that doesn't make sense quite yet, keep reading.
My Account Module Details
This is a module that contains, in list format, all the links from the old User Management Home Page. It can be embedded on any page, but is intended for use primarily on the pages it links to (pages dealing with a user's account). It has a few special features:
The "current page" will be highlighted with a grey background (by default), so if a user is on the My Active Listings page, for instance, the link to that page in the My Account module will be highlighted.
Any item in the list can signal that it "needs attention." For instance, if the account balance is negative, the Add to Account Balance link tells the system it needs attention, and gets colored red (by default). The same happens to the Messages link when a user has unread messages, and the Resume Listing link if the user stops in the middle of a Cart process.
Design Information (advanced):
Design elements of the module, particularly the 'current page' and 'needs attention' highlights I mentioned above, can be controlled by a dedicated CSS file found at geo_templates/[your_template_set]/external/css/module/my_account_links.css. Similarly, the SMARTY template that controls the layout may be found at geo_templates/[your_template_set]/module/my_account_links.tpl. Text shown in the module can be edited in the Admin at Page Modules > Misc. Display > My Account Links Module.
Developer Information (advanced):
The module has hooks for Order Items, Payment Gateways, and Addons to easily add more links. Check the default "subscription" Order Item, "account balance" Payment Gateway, and "signs and flyers" Addon for implementation examples.
<tip c n>Note: This module will not appear if the user is not logged in. For that reason, we recommend using it only on pages directly related to user account management, where the user must be logged in to be, anyway. If you choose to use this module elsewhere, you'll probably want to do so in the context of an HTML Logged In/Out module, so that you can show something to logged out users in that space</tip>
My Account Home Page
This page presents a number of informative statistics to the user, in place of the old "User Management Home Page," which had the links to account management pages now present in the {module tag='my_account_links'} module. Note that while those links are not present in the new My Account Home page, it is designed to go hand-in-hand with this module.
There is a switch in the Admin that selects between the old and new pages. It may be found at Site Setup > User Account Settings > My Account Home Type. Based on that switch, the "body_html" for either the old or new page will be used.
Design Information (Advanced):
Layout of the page is controlled by the SMARTY template file at geo_templates/[your_template_set]/system/user_management/home/my_account_home.tpl and the CSS file at geo_templates/[your_template_set]/external/css/user_management/my_account_home.css. Text shown may be edited in the Admin at Pages Management > User Management > My Account Home Page.
Developer Information (Advanced):
The page has Addon Core Events (hooks) to allow Addons to easily add more stat boxes. See the Example Addon for more information on the software hooks available to use, including implementation examples.