Customising Countries and Calling Codes - Revision history

SarahK at 14:01, 11 December 2020

2020-12-11T14:01:10Z

Matt: /* Troubleshooting */

2017-03-20T10:23:52Z

‎Troubleshooting

John at 09:13, 8 September 2016

2016-09-08T09:13:46Z

Cole at 22:53, 22 July 2016

2016-07-22T22:53:23Z

Matt: /* Customising Countries */

2016-06-13T16:23:46Z

‎Customising Countries

Matt: Created page with "
This documentation page applies to a future as yet unpublished version of WHMCS.
==What are the Countries?== The countries file defines..."

2016-06-13T15:53:09Z

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..."

New page

<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 the countries shown within WHMCS and their respective calling codes.

==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.

<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>

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

===Adding a Country===

Inside your ''/resources/country/countries.json'' file, add a section as follows:

<source lang="yaml">
{
"ABC": {
"name": "Awesome Best Country",
"callingCode": 12345
}
}
</source>

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

===Modifying a Country===

Inside your ''/resources/country/countries.json'' file, add a section as follows:

<source lang="yaml">
{
"GB": {
"name": "Great Britain",
"callingCode": 44
}
}
</source>

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

===Removing a Country===

Inside your ''/resources/country/countries.json'' file, add a section as follows:

<source lang="yaml">
{
"GB": false
}
</source>

The above 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 such as http://www.jsonlint.com/ should help pinpoint the issue.

← Older revision		Revision as of 10:23, 20 March 2017
Line 59:		Line 59:
	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 ''/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 such as http://www.jsonlint.com/ ~~should~~ help pinpoint ~~the issue~~.	+	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/ can help pinpoint any issues.

← Older revision		Revision as of 09:13, 8 September 2016
Line 1:		Line 1:
		+	<div class="docs-alert-info"><i class="fa fa-question-circle"></i> This page describes a feature available in version 7.0 and above</div>
		+
	==What are the Countries?==		==What are the Countries?==

← Older revision		Revision as of 22:53, 22 July 2016
Line 1:		Line 1:
−	~~<div class="docs-alert-warning">This documentation page applies to a future as yet unpublished version of WHMCS.</div>~~
−
	==What are the Countries?==		==What are the Countries?==

@@ Line 1: / Line 1: @@
-<div class="docs-alert-info"><i class="fa fa-question-circle"></i> This page describes a feature available in version 7.0 and above</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?==
 ==Customising Countries==
-−
-The 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.
 ===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">
+{
@@ Line 25: / Line 44: @@
+}
 </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===
-−
-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">
+{
@@ Line 40: / Line 59: @@
+}
 </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===
-−
-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">
+{
@@ Line 52: / Line 71: @@
+}
 </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==
-−
-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.