Difference between revisions of "Customising Countries and Calling Codes"

From WHMCS Documentation

(Created page with "<div class="docs-alert-warning">This documentation page applies to a future as yet unpublished version of WHMCS.</div> ==What are the Countries?== The countries file defines...")
 
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
<div class="docs-alert-warning">This documentation page applies to a future as yet unpublished version of WHMCS.</div>
+
<div class="docs-alert-info">
−
 
+
<i class="fa fa-question-circle"></i>
−
==What are the Countries?==
+
This page describes a feature available in version 7.0 and above.
−
 
+
</div>
−
The countries file defines the countries shown within WHMCS and their respective calling codes.
+
−
 
+
==What is the Countries File?==
 +
 +
The <tt>countries.json</tt> files determines the countries that appear within WHMCS and their respective calling codes.
 +
 +
Primarily, WHMCS uses these lists of country data to determine the contents of the country menu choices for addresses and county call codes. They only have a limited affect on [[Phone_Numbers#Automatic_Number_Formatting|automatic phone number formatting]].
 +
 
==Customising Countries==
 
==Customising Countries==
−
 
+
−
The default country definitions shipped with WHMCS by default can be found in ''resources/country/dist.countries.json''. This file should '''not''' be edited.
+
The default country definitions that ship with WHMCS are in <tt>resources/country/dist.countries.json</tt>. Do '''not''' edit this file.
−
 
+
−
<div class="docs-alert-info"><i class="fa fa-question-circle"></i> Prior to WHMCS 7.0, this file was located at ''/includes/countries.php'' in a different format</div>
+
<div class="docs-alert-info">
−
 
+
<i class="fa fa-question-circle"></i>  
−
To customise the list of countries, begin by creating a custom countries.json file in ''/resources/country/''
+
<span class="title">WHMCS 6.9 and earlier</span><br />
−
 
+
Prior to WHMCS 7.0, this file was located at <tt>/includes/countries.php</tt> in a different format.
 +
</div>
 +
 +
To customise the list of countries, begin by creating a custom <tt>countries.json</tt> file in the <tt>/resources/country/</tt> directory.
 +
 +
===ISO-3116 Countries===
 +
 +
If you add non-ISO-3166 countries, WHMCS adds them to:
 +
 +
* The country menu selections for addresses.
 +
* The country codes used for backend phone parsing.
 +
* The repository that [[Phone_Numbers#Automatic_Number_Formatting|automatic phone number formatting]] uses to format phone numbers.
 +
 +
Removing or changing a country or calling code will '''not''' alter the default ISO-3166 repository that WHMCS uses for [[Phone_Numbers#Automatic_Number_Formatting|automatic phone number formatting]]. Changes and removals are limited to the address country menu choices and the backend phone number formatting logic that WHMCS transmits to external service providers like registrars or gateways.
 +
 
===Adding a Country===
 
===Adding a Country===
−
 
+
−
Inside your ''/resources/country/countries.json'' file, add a section as follows:
+
Inside your custom <tt>/resources/country/countries.json</tt> file, add a section that resembles this example:
−
 
+
 
<source lang="yaml">
 
<source lang="yaml">
 
{
 
{
Line 25: Line 44:
 
}
 
}
 
</source>
 
</source>
−
 
+
−
This will add a country with the display name "Awesome Best Country".
+
This will add a country with the display name <tt>Awesome Best Country</tt>.
−
 
+
 
===Modifying a Country===
 
===Modifying a Country===
−
 
+
−
Inside your ''/resources/country/countries.json'' file, add a section as follows:
+
Inside your custom <tt>/resources/country/countries.json</tt> file, add a section that resembles this example:
−
 
+
 
<source lang="yaml">
 
<source lang="yaml">
 
{
 
{
Line 40: Line 59:
 
}
 
}
 
</source>
 
</source>
−
 
+
−
The above would customise the display name for United Kingdom (GB) to Great Britain.
+
The above example would customise the display name for United Kingdom (GB) to <tt>Great Britain</tt>.
−
 
+
 
===Removing a Country===
 
===Removing a Country===
−
 
+
−
Inside your ''/resources/country/countries.json'' file, add a section as follows:
+
Inside your custom <tt>/resources/country/countries.json</tt> file, add a section that resembles this example:
−
 
+
 
<source lang="yaml">
 
<source lang="yaml">
 
{
 
{
Line 52: Line 71:
 
}
 
}
 
</source>
 
</source>
−
 
+
−
The above would remove GB (United Kingdom) from the available countries within WHMCS.
+
The above example would remove GB (United Kingdom) from the available countries within WHMCS.
−
 
+
 
==Troubleshooting==
 
==Troubleshooting==
−
 
+
−
If after making an edit to your custom ''/resources/country/countries.json'' file, it does not take effect, this indicates that the file contains invalid syntax.
+
If, after making an edit to your custom <tt>/resources/country/countries.json</tt> file, it does not take effect, this indicates that the file contains invalid syntax. The file must contain valid JSON syntax. Running the contents of your file through [http://www.jsonlint.com/ an online syntax validation checker] can help you find any issues.
−
 
 
−
The file must contain valid JSON Syntax. Running the contents of your file through an online syntax validation checker such as http://www.jsonlint.com/ should help pinpoint the issue.
 

Latest revision as of 14:01, 11 December 2020

This page describes a feature available in version 7.0 and above.

What is the Countries File?

The countries.json files determines the countries that appear within WHMCS and their respective calling codes.

Primarily, WHMCS uses these lists of country data to determine the contents of the country menu choices for addresses and county call codes. They only have a limited affect on automatic phone number formatting.

Customising Countries

The default country definitions that ship with WHMCS are in resources/country/dist.countries.json. Do not edit this file.

WHMCS 6.9 and earlier
Prior to WHMCS 7.0, this file was located at /includes/countries.php in a different format.

To customise the list of countries, begin by creating a custom countries.json file in the /resources/country/ directory.

ISO-3116 Countries

If you add non-ISO-3166 countries, WHMCS adds them to:

  • The country menu selections for addresses.
  • The country codes used for backend phone parsing.
  • The repository that automatic phone number formatting uses to format phone numbers.

Removing or changing a country or calling code will not alter the default ISO-3166 repository that WHMCS uses for automatic phone number formatting. Changes and removals are limited to the address country menu choices and the backend phone number formatting logic that WHMCS transmits to external service providers like registrars or gateways.

Adding a Country

Inside your custom /resources/country/countries.json file, add a section that resembles this example: 

{
    "ABC": {
        "name": "Awesome Best Country",
        "callingCode": 12345
    }
}

This will add a country with the display name Awesome Best Country.

Modifying a Country

Inside your custom /resources/country/countries.json file, add a section that resembles this example: 

{
    "GB": {
        "name": "Great Britain",
        "callingCode": 44
    }
}

The above example would customise the display name for United Kingdom (GB) to Great Britain.

Removing a Country

Inside your custom /resources/country/countries.json file, add a section that resembles this example: 

{
    "GB": false
}

The above example would remove GB (United Kingdom) from the available countries within WHMCS.

Troubleshooting

If, after making an edit to your custom /resources/country/countries.json file, it does not take effect, this indicates that the file contains invalid syntax. The file must contain valid JSON syntax. Running the contents of your file through an online syntax validation checker can help you find any issues.

Retrieved from "http://3.17.75.209/index.php?title=Customising_Countries_and_Calling_Codes&oldid=29771"