Automatic Currency, Language And Template Setup For WHMCS – Updated

The recognition of our Geolocation Hook For WHMCS has been continuously growing among the global community of WHMCS users. Having this exhilarating trend in mind, we felt extremely tempted to breathe new life into the original Blog post dated March 2013, and show the current potential lying within this simple, yet undoubtedly powerful tool.

One of the most interesting novelties as compared to the then hook’s advantages is the addition of support for Polish Language Translation For WHMCS. With it, all Polish clients will enjoy a detailed localization of your entire system into their very own mother tongue.

What we present below is the catalog of most essential maneuvers you may carry out thanks to our hook. To help you find your way through the particular features more easily, the article has been supplemented with the exact code lines and clear guidelines on how to adjust them.

1. Configure the rules of currency, language and template changes

Adjustment of the client area pages depending on your clients location has been simplified to the maximum possible level. Edit the code with the provided in the commented areas tips to achieve any configuration of currency, language and templates.

PHP

/** * Define relations between countries and currencies. * Enter the currency code for each country (codes used), use the below pattern, edit it or add new entries below: */ $countryToCurrency = array( 'default' => 'USD', 'US' => 'USD', 'GB' => 'GBP', // NOTE: You can add more below );

1 2 3 4 5 6 7 8 9 10

/** * Define relations between countries and currencies. * Enter the currency code for each country (codes used), use the below pattern, edit it or add new entries below: */ $countryToCurrency = array( 'default' => 'USD', 'US' => 'USD', 'GB' => 'GBP', // NOTE: You can add more below );

PHP

/** * Define language rules by assigning a language to a single country. * Use the below pattern (language name for country code) edit it and/or add new entries below: */ $countryToLanguage = array( 'default' => 'english', 'US' => 'english', 'DE' => 'german', 'NO' => 'norwegian', // NOTE: You can add more below );

1 2 3 4 5 6 7 8 9 10 11

/** * Define language rules by assigning a language to a single country. * Use the below pattern (language name for country code) edit it and/or add new entries below: */ $countryToLanguage = array( 'default' => 'english', 'US' => 'english', 'DE' => 'german', 'NO' => 'norwegian', // NOTE: You can add more below );

PHP

/** * Configure additional settings: * Firstly assign a WHMCS template to each country used. * Use the below pattern (template name for country code) edit it and/or add new entries below: */ $countryToTemplate = array( 'US' => 'six', 'default' => 'six', // NOTE: You can add more below );

1 2 3 4 5 6 7 8 9 10

/** * Configure additional settings: * Firstly assign a WHMCS template to each country used. * Use the below pattern (template name for country code) edit it and/or add new entries below: */ $countryToTemplate = array( 'US' => 'six', 'default' => 'six', // NOTE: You can add more below );

PHP

/** * Now, define the language for each WHMCS template used. * Please note that a template available in WHMCS V7 is: 'six'. * It is important to use a template that exists within your WHMCS system. * Not Logged In Users */ $templateToLanguage = array( 'english' => 'six', 'german' => 'six', 'default' => 'six', // NOTE: You can add more below );

1 2 3 4 5 6 7 8 9 10 11 12

/** * Now, define the language for each WHMCS template used. * Please note that a template available in WHMCS V7 is: 'six'. * It is important to use a template that exists within your WHMCS system. * Not Logged In Users */ $templateToLanguage = array( 'english' => 'six', 'german' => 'six', 'default' => 'six', // NOTE: You can add more below );

2. Select a template depending on a mobile device or a domain used

You may point a template that shall be called, following the device type used, a tablet or a mobile. In the very same way, point the domain names that your visitors are redirected from, to turn on a specific template for them. Uncomment the lines and provide required templates names.

PHP

/** * You may define a mobile template per a mobile device: mobile and tablet types. * Use the below pattern (template name for mobile device) and edit the entries. * Comment out to disable the option. */ $mobileToTemplate = [ // 'mobile' => 'mobile_template', // 'tablet' => 'tablet_template', ];

1 2 3 4 5 6 7 8 9

/** * You may define a mobile template per a mobile device: mobile and tablet types. * Use the below pattern (template name for mobile device) and edit the entries. * Comment out to disable the option. */ $mobileToTemplate = [ // 'mobile' => 'mobile_template', // 'tablet' => 'tablet_template', ];

PHP

/** * You may define templates per domain name. Enter a domain name and assign a template to each one of them. * Uncomment the below examples to turn on. */ $domainToTemplate = [ //'www.example.mobi' => 'mobile_template', //'www.example.com' => 'six', ];

1 2 3 4 5 6 7 8

/** * You may define templates per domain name. Enter a domain name and assign a template to each one of them. * Uncomment the below examples to turn on. */ $domainToTemplate = [ //'www.example.mobi' => 'mobile_template', //'www.example.com' => 'six', ];

3. Select adjustable pages of your client area

The hook offers huge flexibility when it comes to personalizing a whole or just a specific part of your client area. You are free to select the exact pages where the alterations should be performed.

PHP

/** * Enter pages in your WHMCS which the hook will be active for. * Add more pages at the bottom of the list, comment out single pages to disable the hook for them: */ $allowedScripts = array( 'p1.php', 'index.php', 'clientarea.php', 'cart.php', 'knowledgebase.php', 'announcements.php', 'serverstatus.php', 'affiliates.php', 'contact.php', // NOTE: You can add more below );

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16

/** * Enter pages in your WHMCS which the hook will be active for. * Add more pages at the bottom of the list, comment out single pages to disable the hook for them: */ $allowedScripts = array( 'p1.php', 'index.php', 'clientarea.php', 'cart.php', 'knowledgebase.php', 'announcements.php', 'serverstatus.php', 'affiliates.php', 'contact.php', // NOTE: You can add more below );

4. Disable the hook with ease

There might be cases when you do not wish the hook to alter the client area. You are given a wide range of possibilities to turn off the hook for specific IP addresses, IP pools or certain user agents – all is up to you!

PHP

/** * Point single IP addresses. The hook will be turned off for these addresses. * Uncomment the below list and edit the exemplary addresses, add more at the bottom of the list: */ $disabledForIPs = array( // '91.192.166.22', // '192.168.0.39', // NOTE: You can uncomment or add more below );

1 2 3 4 5 6 7 8 9

/** * Point single IP addresses. The hook will be turned off for these addresses. * Uncomment the below list and edit the exemplary addresses, add more at the bottom of the list: */ $disabledForIPs = array( // '91.192.166.22', // '192.168.0.39', // NOTE: You can uncomment or add more below );

PHP

/** * Point full IP pools. The hook will be turned off for the addresses in these pools. * Uncomment the below list and edit the exemplary addresses, add more at the bottom of the list: */ $disabledForCidrIPs = array( // '192.168.56.0/24', // '192.168.0.39/24', // NOTE: You can uncomment or add more below );

1 2 3 4 5 6 7 8 9

/** * Point full IP pools. The hook will be turned off for the addresses in these pools. * Uncomment the below list and edit the exemplary addresses, add more at the bottom of the list: */ $disabledForCidrIPs = array( // '192.168.56.0/24', // '192.168.0.39/24', // NOTE: You can uncomment or add more below );

PHP

/** * Point user agents. The hook will be turned off for the enumerated here devices/browsers. * Enter a short or a full user agent name like in the examples below. * Uncomment the below list and edit the exemplary entries, add more at the bottom of the list: */ $disabledForBrowsers = array( // 'Chrome', // 'Firefox', // 'Google-Site-Verification', // 'Mozilla/5.0 (compatible; Googlebot/2.1; +http://www.google.com/bot.html )', // 'Mozilla/5.0 (compatible; MSIE 10.0; Windows NT 7.1; Trident/5.0)', // NOTE: You can uncomment or add more below );

1 2 3 4 5 6 7 8 9 10 11 12 13

/** * Point user agents. The hook will be turned off for the enumerated here devices/browsers. * Enter a short or a full user agent name like in the examples below. * Uncomment the below list and edit the exemplary entries, add more at the bottom of the list: */ $disabledForBrowsers = array( // 'Chrome', // 'Firefox', // 'Google-Site-Verification', // 'Mozilla/5.0 (compatible; Googlebot/2.1; +http://www.google.com/bot.html )', // 'Mozilla/5.0 (compatible; MSIE 10.0; Windows NT 7.1; Trident/5.0)', // NOTE: You can uncomment or add more below );

5. Get the country with MaxMind GeoIP2

In order to track your clients’ locations, either use the included in the package submodule, or add your own submodule.

PHP

/** * Get the country using an external service, e.g. MaxMind GeoLite * http://dev.maxmind.com/geoip/geolite * NOTE: You can also create your own submodule, edit the below line in such case as only one submodule can work at a time. */ $submodule = 'GeoIP2';

1 2 3 4 5 6

/** * Get the country using an external service, e.g. MaxMind GeoLite * http://dev.maxmind.com/geoip/geolite * NOTE: You can also create your own submodule, edit the below line in such case as only one submodule can work at a time. */ $submodule = 'GeoIP2';

If the article does not cover the configuration scheme you look for, it most likely can be found in our Wiki article. Apart from detailed instructions on how to upload and configure the tool, you will find there several visualizations of how the client area may be adapted with this neat, completely free of charge hook.

Get the Hook!