Additional Domain Fields - Revision history

SarahK: /* What are additional domain fields? */

2022-04-18T16:07:44Z

‎What are additional domain fields?

SarahK: /* Translate a field name */

2020-05-18T17:40:35Z

‎Translate a field name

SarahK: /* Prepopulated Data Variables */

2020-05-18T17:38:36Z

‎Prepopulated Data Variables

SarahK at 17:37, 18 May 2020

2020-05-18T17:37:56Z

Show changes

Matt at 18:36, 26 November 2019

2019-11-26T18:36:21Z

AlexN: /* How do I customise the fields that are displayed? */

2019-06-18T06:36:44Z

‎How do I customise the fields that are displayed?

AlexN: /* How do I customise the fields that are displayed? */

2019-06-18T06:36:27Z

‎How do I customise the fields that are displayed?

Nathan: /* How do I customise the fields that are displayed? */

2019-03-06T14:53:31Z

‎How do I customise the fields that are displayed?

PeterB: typo

2019-02-27T17:24:50Z

typo

John: /* How do I customise the fields that are displayed? */

2017-08-31T08:21:10Z

‎How do I customise the fields that are displayed?

← Older revision		Revision as of 16:07, 18 April 2022
Line 6:		Line 6:

	When a domain registry requires information, a domain name will fail to register successfully unless you provide the values. For example, the information that domain registries request often includes things like the Registrant Legal Type and Registered Entity Name.		When a domain registry requires information, a domain name will fail to register successfully unless you provide the values. For example, the information that domain registries request often includes things like the Registrant Legal Type and Registered Entity Name.
		+
		+	For general information about domains in WHMCS, see [[Domains Management]].

	==When are the fields asked for?==		==When are the fields asked for?==

@@ Line 84: / Line 84: @@
 </div>
-You can translate the field name via [https://developers.whmcs.com/languages/overrides/ language override files]. This allows you to change the label on the shopping cart next to the additional domain field based upon the language in which the visitor is viewing your site.
+You can translate the field name via [https://developers.whmcs.com/languages/overrides/ language override files]. This allows you to change the label on the shopping cart next to the additional domain field based upon the language in which the visitor is viewing your site. For more information, see [[Easy_Translation#Localising_a_Field|Easy Translation]].
 ==Prepopulated Data Variables==

@@ Line 92: / Line 92: @@
 <table class="table table-striped table-condensed">
 <tr><th>Tag</th><th>Description</th></tr>
-<tr><td>{Countries}</td><td>Provides a comma-separated list of countries. The system will save a full country name and pass it to the registrar for the field (for example, United Kingdom).</td></tr>
+<tr><td><tt>{Countries}</tt></td><td>Provides a comma-separated list of countries. The system will save a full country name and pass it to the registrar for the field (for example, United Kingdom).</td></tr>
-<tr><td>{CountryCodeMap}</td><td>Provides an associative key-and-value pair list of country codes and country names. This will display the full country name for a user to choose, but it will only store and pass the ISO country code to the registrar (for example, GB).</td></tr>
+<tr><td><tt>{CountryCodeMap}</tt></td><td>Provides an associative key-and-value pair list of country codes and country names. This will display the full country name for a user to choose, but it will only store and pass the ISO country code to the registrar (for example, GB).</td></tr>
 </table>

← Older revision		Revision as of 18:36, 26 November 2019
Line 104:		Line 104:
	);		);
	</source>		</source>
		+
		+	==Conditional Requirements==
		+
		+	<div class="docs-alert-info"><i class="fa fa-info-circle"></i> This feature is available in WHMCS 7.9 and above.</div>
		+
		+	Additional domain fields can be set as never required, always required, or conditionally required. A conditional requirement allows a field to be denoted as required only when another field contains a certain value. This allows for more complex validation rules to be defined.
		+
		+	===How it Works===
		+
		+	It is easiest to illustrate how to define a conditionally required additional domain field by looking at an example:
		+
		+	<source lang="php">
		+	$additionaldomainfields['.co.uk'][] = [
		+	'Name' => 'Company ID Number',
		+	'LangVar' => 'uktldcompanyid',
		+	'Type' => 'text',
		+	'Size' => '30',
		+	'Required' => [
		+	'Legal Type' => [
		+	'UK Limited Company',
		+	'UK Public Limited Company',
		+	],
		+	],
		+	];
		+	</source>
		+
		+	In the example above, the field "Company ID Number" is only required when the value of the "Legal Type" field is one of either "UK Limited Company" or "UK Public Limited Company".
		+
		+	A conditional requirement is defined by setting the value of the 'Requires' key to an array, containing a list of field names and values that trigger the requirement. The array syntax here supports multiple fields to be defined, and the field will be required if any of the required fields have one of the defined values selected/specified.
		+
		+	As with all customisations, if you wish to override the default requirements for a given field, you should do so using an override file as described above.

@@ Line 83: / Line 83: @@
 </source>
-The field name can be translated via [https://developers.whmcs.com/languages/overrides/ language override files]]. This allows you to change the label displayed on the shopping cart next to the additional domain field based upon the language in which the visitor is viewing your site.
+The field name can be translated via [https://developers.whmcs.com/languages/overrides/ language override files]. This allows you to change the label displayed on the shopping cart next to the additional domain field based upon the language in which the visitor is viewing your site.
 ==Prepopulated Data Variables==

@@ Line 45: / Line 45: @@
 # Remove any key/value pairs for parameters you do not wish to customise
 # Customise the remaining options as desired (in the example below the option values are being customised to just the 3 most commonly used options)
 <source lang="php">
 $additionaldomainfields[".co.uk"][] = array(
      "Name" => "Legal Type",
-     "Options" => "Individual,UK Limited Company,UK Public Limited Company",
+     "Options" => "1|Individual,2|UK Limited Company,3|UK Public Limited Company",
 );
 </source>

@@ Line 82: / Line 82: @@
 </source>
-The field name can be translated via [[Language_Overrides|language override files]]. This allow you to change the label displayed on the shopping cart next to the additional domain field based upon the language in which the visitor is viewing your site.
+The field name can be translated via [[Language_Overrides|language override files]]. This allows you to change the label displayed on the shopping cart next to the additional domain field based upon the language in which the visitor is viewing your site.
 ==Prepopulated Data Variables==

@@ Line 65: / Line 65: @@
 '''Translating a Field Name'''<br/>
 # Define the field within your custom ''/resources/domains/additionalfields.php'' file and set the '''LangVar''' attribute to the desired language variable
 # Add the translation string with the corresponding attribute to your language override file
@@ Line 82: / Line 81: @@
 $_LANG['uktldlegaltype'] = "Custom Field Label Text";
 </source>
 ==Prepopulated Data Variables==