Version 5.0 Release Notes

From WHMCS Documentation

Revision as of 16:45, 14 December 2011 by Matt (talk | contribs) (Release Information)

Release Information

Version 5.0.0

  • Release Type: Beta (For Testing)
  • Release Date: 7th October 2011

Version 5.0.1

  • Release Type: Release Candidate
  • Release Date: 14th November 2011

Version 5.0.2

  • Release Type: Stable Release (Changelog)
  • Release Date: 24th November 2011

Version 5.0.3

  • Release Type: Stable Release (Changelog)
  • Release Date: 14th December 2011

Changelog

A full overview of the new features and functionality added in WHMCS Version 5.0 can be found in the PDF Download at the url below.

http://www.whmcs.com/members/dl.php?type=d&id=104

Upgrade Steps

Upgrading WHMCS is easy. To upgrade to V5.0, simply follow the steps below:

  1. Begin by taking a backup of your database using a tool such as phpMyAdmin
  2. Now download the latest WHMCS version either from our client area (http://wiki.whmcs.com/Upgrading#Downloading_the_Latest_Version) or from your web host license provider
  3. Next, unzip the contents of the WHMCS zip file download to a folder on your computer
  4. Now if you have customised your WHMCS admin folder name, you should rename the admin folder in the new files to match
  5. Upload the new files to your existing installation folder replacing any existing folders & files
  6. Visit the admin area as you normally would to login and you should then see the upgrade script
  7. Accept the license agreement
  8. Tick to confirm you have backed up your database and click the upgrade button
  9. Once the updates finish, delete the install folder from your server

These steps can be used to upgrade from any version of WHMCS from V3.3 & later.

Remember: After upgrading, your browser may still display cached versions of the previous files. So if you get any display issues or inconsistencies, always try clearing your cache first, both in your browser, and the WHMCS templates cache (templates_c folder files)

The upgrade is now completed. The only thing left to do is update your custom templates if you have any with the new and changed template files for the new version. See below for details.

Template Changes

In Version 5.0, the previously named "default" template theme has been renamed to "classic". And the new "Default" style is the newly introduced V5 theme. So these template changes below apply to both the "classic" and "portal" template styles, with the line references taken from "classic".

  • announcements.tpl - Twitter, Facebook & Google+ Social Integration (Lines 20, 22-36, 41-44, 52-53)
  • bulkdomainchecker.tpl - reCAPTCHA Integration (Lines 3-4,12-23,30-33)
  • bulkdomainmanagement.tpl - ** New File **
  • bulkdomaintransfer.tpl - reCAPTCHA Integration (Lines 3-4,12-23,30-33)
  • clientareacancelrequest.tpl - Added Domain Auto Renew Disable Functionality (Lines 17-18,27-36,43)
  • clientareachangepw.tpl - New my details links bar include (Line 3)
  • clientareachangesq.tpl - New my details links bar include (Line 1)
  • clientareacontacts.tpl - New my details links bar include (Line 21)
  • clientareacreditcard.tpl - Replaced expiry date input with dropdowns + New Links (Lines 1 & 39)
  • clientareadetails.tpl - New my details links bar include + Default Payment Method Select (Line 3 & 33-38)
  • clientareadetailslinks.tpl - ** New File **
  • clientareadomaincontactinfo.tpl - New WHOIS Info Management Options (Lines 1-15,18-19,28-44,48)
  • clientareadomaindetails.tpl - Nameserver Changes Updates (Lines 1-13, 54-57)
  • clientareadomaindns.tpl - Update to Registrar Linked DNS Host Record Management Handling (Line 26)
  • clientareadomains.tpl - Bulk Domain Management Functionality Added (Lines 1-6,13-14,16,18,23-34)
  • clientareahome.tpl - Inline CSS Removed + SSL Twitter Feed Added (Lines 10-131 & 123)
  • clientareaproductdetails.tpl - Password Change Confirmation Messages (Lines 45-48)
  • clientregister.tpl - reCAPTCHA Integration + Language Update (Lines 2-4,62-68)
  • contact.tpl - reCAPTCHA Integration (Lines 22-30)
  • creditcard.tpl - Replaced expiry date input with dropdowns (Lines 46)
  • domainchecker.tpl - reCAPTCHA Integration (Lines 23-34)
  • downloads.tpl - Updated Language Strings (Line 23)
  • header.tpl - Optional but recommended addon module output template tag additions (Lines 9,13-14)
  • footer.tpl - Optional but recommended addon module output template tag additions (Lines 10-11)
  • invoicepdf.tpl - Updated table display method
  • knowledgebase.tpl - Updated Language Strings (Line 23)
  • quotepdf.tpl - Updated table display method
  • style.css - Various CSS styling updates & changes - 15,414-418,471-594
  • supportticketsubmit-steptwo.tpl - Priority Remembering & reCAPTCHA integration (Lines 45-47 & 69-77)
  • viewannouncement.tpl - Twitter, Facebook & Google+ Social Integration (Lines 3-8,10-55)

The header & footer template changes above are optional, but recommended to ensure compatability with future addons both released by us and third party module developers. Likewise as are the invoicepdf.tpl, quotepdf.tpl and style.css updates. But all other files updates are recommended to ensure you have trouble free access to all the new functionality.

New Language File Lines

If you are using a custom language file, then the new language file lines introduced in Version 5.0 can be found below the "# Version 5.0" line in each language file.

Release Notes

  • Always clear your browser cache, or perform a hard refresh after upgrading, most display related issues are purely due to seeing an old version of the CSS
  • New Admin Settings that you might want to review after upgrading:
Localisation Tab > Client Date Format - http://docs.whmcs.com/Localisation_Tab#Client_Date_Format
Support Tab > Attachment Thumbnail Previews - http://docs.whmcs.com/Support_Tab#Attachment_Thumbnail_Previews
Support Tab > Include Product Downloads - http://docs.whmcs.com/Support_Tab#Include_Product_Downloads
Secutrity Tab > Captcha Type - http://docs.whmcs.com/Security_Tab#Captcha_Type
Security Tab > Disable Admin Password Reset - http://docs.whmcs.com/Security_Tab#Disable_Admin_Password_Reset
Social Tab - http://docs.whmcs.com/Social_Networking
Other Tab > Default to Client Area - http://docs.whmcs.com/Other_Tab#Default_to_Client_Area
  • The Staff Noticeboard feature is an optional addon module, accessible via Setup > Addon Modules
  • The Google Analytics addon module template tag has been changed from the previous value to use the new built in client area output tags, thus requiring any custom footer.tpl template files to be updated with the new {$footeroutput} tag
  • Client area language files have been changed from .txt to .php files in this release. The old .txt files can be removed from the /lang/ folder.

Documentation Links

New Hook Points

  • ClientLoginShare - Allowing Client LoginShare
  • ClientAreaPage, ClientAreaHeadOutput, ClientAreaHeaderOutput, ClientAreaFooterOutput - for client area global output
  • AdminAreaPage, AdminAreaHeadOutput, AdminAreaHeaderOutput, AdminAreaFooterOutput - for admin area global output
  • AddonAdd, AddonEdit, AddonSuspended, AddonTerminated, AddonCancelled, AddonFraud, AddonDeleted, AddonConfig, AddonConfigSave - For addon management
  • AdminClientProfileTabFields,AdminClientProfileTabFieldsSave - To allow for custom fields in products/services management pages
  • ContactEdit,ContactDelete - Edit updated with "olddata"
  • PreServiceEdit,ServiceDelete
  • DomainEdit,DomainDelete
  • ClientAreaRegister - To allow differentiating a manual signup
  • PreModuleXXXX - Added ability to abort module command from pre module hook
  • EmailTplMergeFields - to allow defining additional merge fields in email templates config page
  • AdminInvoicesControlsOutput - for adding controls to the invoice page
  • DomainValidation,CartSubdomainValidation,LinkTracker,FileDownload,TicketClose - Miscellaneous