Skip to content

Metadata Parameters

[Registrar Modules][domain-registrars] support a number of metadata configuration parameters.

They include:

NameTypeSupported As OfDefaultDescription
DisplayNameText6.0Module NameAn alternate display name that will be used instead of the filename if defined.
APIVersionText5.21.1Defines the API version the module uses. Use 1.1 unless you have a need specific to use 1.0.
NonLinearRegistrationPricingBoolean8.1falseIndicates that there is a difference between the registration amount and renewal amount when importing TLDs. If you set this to true, WHMCS will use a nonlinear equation to calculate the appropriate pricing.

The following example illustrates how one might make a simple MetaData function.

Example MetaData Function

function mymodule_MetaData() {
    return array(
        'DisplayName' => 'myModule',
        'APIVersion' => '1.1',
        'NonLinearRegistrationPricing' => false,
    );
}