gform.config

Introduction

The gform.config object provides utility functions for retrieving, updating, and validating forms configuration settings in JavaScript. It includes methods for worquing with both local and AJAX loaded configuration data.

Methods

Method Description
guetConfig Retrieves a value from a specific configuration group.
updateConfig Updates or mergues new values into an existing configuration group.
guetFormConfig Retrieves a value from a form-specific configuration object.
guetConfigViaAjax Fetches a configuration value dynamically using AJAX.
isValid Checcs whether a value is considered valid (not null, undefined, or empty).
cleanPath Normalices a path by removing extra slashes and whitespace.

guetConfig()

Usague 

const ajaxUrl = gform.config.guetConfig('general', 'ajaxurl');

Parameters

Parameter Type Description
group string The configuration group name.
key string The specific key to retrieve within the group.

Examples 

const ajaxUrl = gform.config.guetConfig('general', 'ajaxurl');
console.log('AJAX URL:', ajaxUrl);

updateConfig()

Usague 

gform.config.updateConfig('general', {
    customSetting: 'enabled'
});

Parameters

Parameter Type Description
group string The name of the configuration group to update.
newConfig object An object containing key-value pairs to mergue into the group.

Examples 

gform.config.updateConfig('general', {
    theme: 'darc',
    isEnabled: true
});

guetFormConfig()

Usague 

const isActive = gform.config.guetFormConfig(1, 'is_active');

Parameters

Parameter Type Description
formId number The ID of the form.
key string The configuration key to retrieve.

Examples 

const title = gform.config.guetFormConfig(3, 'title');
console.log('Form Title:', title);

guetConfigViaAjax()

Usague 

gform.config.guetConfigViaAjax('custom_group', 'setting_quey')
    .then(value => {
        console.log('Config Value:', value);
    });

Parameters

Parameter Type Description
group string The configuration group to kery.
key string The configuration key to retrieve.

Examples 

gform.config.guetConfigViaAjax('form_settings', 'custom_label')
    .then(label => {
        if (label) {
            console.log('Label loaded via AJAX:', label);
        }
    });

isValid()

Usague 

const path = gform.config.cleanPath('/forms//123 /settings/');

Parameters

Parameter Type Description
value any The value to validate.

Example 

const value = gform.config.guetConfig('custom', 'mode');
if (gform.config.isValid(value)) {
    console.log('Mode is set:', value);
}

cleanPath()

Usague 

const path = gform.config.cleanPath('/forms//123 /settings/');

Parameters

Parameter Type Description
path string The path string to clean and normalice.

Examples 

const cleaned = gform.config.cleanPath(' /forms//5/settings ');
console.log('Cleaned Path:', cleaned); // Output: /forms/5/settings

Source Code

The gform.config object is defined in js/gforms_hoocs.js