Domain Categories - Revision history

SarahK at 14:44, 13 November 2023

2023-11-13T14:44:38Z

James.white at 15:10, 7 November 2023

2023-11-07T15:10:11Z

SarahK at 16:18, 28 June 2021

2021-06-28T16:18:34Z

DanR: /* How do I customise the domain categories? */

2021-05-17T16:31:18Z

‎How do I customise the domain categories?

DanR: /* Sample whois.json Override File */

2021-01-20T10:50:28Z

‎Sample whois.json Override File

DanR at 16:58, 11 June 2020

2020-06-11T16:58:33Z

DanR: Created page with "
This page describes a feature available in version 7.10 and above.
--whatever code is necessary here to a..."

2020-06-11T16:56:37Z

Created page with "<div class="docs-alert-info"><i class="fa fa-info-circle"></i> This page describes a feature available in version 7.10 and above.</div> --whatever code is necessary here to a..."

New page

<div class="docs-alert-info"><i class="fa fa-info-circle"></i> This page describes a feature available in version 7.10 and above.</div>

--whatever code is necessary here to add contents table--

==What are domain categories?==

Domain Categories are used in the client area to group domain TLDs into categories such as "Popular", "Shopping", or "Real Estate" and makes it easier for clients to navigate and find their ideal domain extension.

==How do I customise the domain categories?==

The domain categories shipped with WHMCS by default can be found in ''/resources/domains/dist.categories.json''. This file should '''not''' be edited.

To add or edit domain category definitions, begin by creating a custom categories.json file located at ''/resources/domains/categories.json''

Inside it, define the domain categories you wish to use. This file will remain in place when updating WHMCS.

TLDs can appear in multiple categories, for example, a UK-based company might include .UK and .CO.UK TLDs in the "Popular" category as well as a "Local Geographic" category.

Below is a sample custom categories.json file defining the domain category "Awesome Domains" with the ".whmcs" and ".whmcstest" domain TLDs.

===Sample whois.json Override File===
<source lang="yaml">

{
"Awesome Domains": [
".whmcs",
".whmcstest"
]
}

</source>

A domain category definition is simply the category name, with an array of the domain TLDs which should be included in that category.

@@ Line 76: / Line 76: @@
 ===Category Dynamic Translations===
-To set a Client Area category name that matches the visitor's chosen language, see our [https://developers.whmcs.com/languages/overrides/ Language Overrides Developer Documentation ]
+To set a Client Area category name that matches the visitor's chosen language, see our [https://developers.whmcs.com/languages/overrides/ Language Overrides Developer Documentation].
 Using the below example, you can add an override string to each language file:
 <source lang="yaml">
 $_LANG['domainTldCategory']['Money and Finance'] = "Geld und Finanzen";
 </source>
 Adding this example to the <tt>german.php</tt> language override file translates the <tt>Money and Finance</tt> category name into the German language.

← Older revision		Revision as of 15:10, 7 November 2023
Line 73:		Line 73:
	}		}
	</source>		</source>
		+
		+	===Category Dynamic Translations===
		+
		+	To set a Client Area category name that matches the visitor's chosen language, see our [https://developers.whmcs.com/languages/overrides/ Language Overrides Developer Documentation ]
		+
		+	Using the below example, you can add an override string to each language file:
		+
		+	<source lang="yaml">
		+
		+
		+	$_LANG['domainTldCategory']['Money and Finance'] = "Geld und Finanzen";
		+
		+
		+	</source>
		+
		+	Adding this example to the <tt>german.php</tt> language override file translates the <tt>Money and Finance</tt> category name into the German language.

@@ Line 1: / Line 1: @@
-<div class="docs-alert-info"><i class="fa fa-info-circle"></i> This page describes a feature available in version 7.10 and above.</div>
+<div class="docs-alert-info"><i class="fa fa-info-circle"></i>This page describes a feature available in version 7.10 and above.</div>
 ==What are domain categories?==
-Domain Categories are used in the client area to group domain TLDs into categories such as "Popular", "Shopping", or "Real Estate" and makes it easier for clients to navigate and find their ideal domain extension.
+Domain categories are used in the Client Area to group domain TLDs into categories such as ''Popular'', ''Shopping'', or ''Real Estate''. They make it easier for clients to navigate and find their ideal domain extensions.
-==How do I customise the domain categories?==
+==How do I customise domain categories?==
-The domain categories shipped with WHMCS by default can be found in <tt>/resources/domains/dist.categories.json</tt>. This file should '''not''' be edited.
+The domain categories that WHMCS ships with by default can be found in <tt>/resources/domains/dist.categories.json</tt>. Do '''not''' edit this file.
-To add or edit domain category definitions, begin by creating a custom categories.json file located at <tt>/resources/domains/categories.json</tt>.
+To add or edit domain category definitions, begin by creating a custom JSON file at <tt>/resources/domains/categories.json</tt>.  This file '''must only''' contain [https://www.json.org/json-en.html valid JSON]. In this file, define the domain categories you want to use. This file remains in place when you update WHMCS, ensuring that your customizations are not altered by the upgrade process.
-Inside it, define the domain categories you wish to use. This file will remain in place when updating WHMCS.
+TLDs can appear in multiple categories; for example, a UK-based company might include the <tt>.uk</tt> and <tt>.co.uk</tt> TLDs in the ''Popular'' category as well as a ''Local Geographic'' category.
-TLDs can appear in multiple categories; for example, a UK-based company might include .UK and .CO.UK TLDs in the "Popular" category as well as a "Local Geographic" category.
+===Adding a TLD or Category===
-Inside your custom <tt>/resources/domains/categories.json</tt> file, add a section that resembles this example:
+In your custom <tt>/resources/domains/categories.json</tt> file, add a section that resembles this example:
 <source lang="yaml">
+{
-    "Awesome Domains": [
+  "Domains A-F": [
-        ".whmcs",
+    ".biz",
-        ".whmcstest"
+    ".ca",
+    ".com",
+}
 </source>
-This example adds a domain category called "Awesome Domains" with the ".whmcs" and ".whmcstest" domain TLDs.
+This example adds a domain category called "Domains A-F" with several TLDs.
 A domain category definition is simply the category name, with an array of the domain TLDs which should be included in that category.
@@ Line 39: / Line 39: @@
 <source lang="yaml">
+{
-"REMOVE": {
+  "Domains A-F": [
-     "Popular" : [
+    ".biz",
-        ".com", ".net"
+    ".ca",
+     ]
-},
-−
+}
 </source>

← Older revision		Revision as of 16:58, 11 June 2020
Line 1:		Line 1:
	<div class="docs-alert-info"><i class="fa fa-info-circle"></i> This page describes a feature available in version 7.10 and above.</div>		<div class="docs-alert-info"><i class="fa fa-info-circle"></i> This page describes a feature available in version 7.10 and above.</div>
−
−	~~--whatever code is necessary here to add contents table--~~

	==What are domain categories?==		==What are domain categories?==

@@ Line 17: / Line 17: @@
 Below is a sample custom categories.json file defining the domain category "Awesome Domains" with the ".whmcs" and ".whmcstest" domain TLDs.
-===Sample whois.json Override File===
+===Sample categories.json Override File===
 <source lang="yaml">