Elegant Themes

Note: This tutorial series is intended for advanced users. An advanced understanding of coding in PHP and JavaScript is required.

Module settings are defined in the <code>get_fields()</code> method of the module’s PHP class. A setting definition is simply an associative array of parameters.

type (<code>string</code>) — The <a href="#field-types">field type</a> used to render the setting in the module settings modal

- type (<code>string</code>) — The <a href="#field-types">field type</a> used to render the setting in the module settings modal

default (<code>string</code>) — Default value

description (<code>string</code>) — Description (localized)

id (<code>string</code>) — CSS id for the setting’s field

label (<code>string</code>) — Display name (localized)

option_category (<code>string</code>) — Option category slug (for the Divi Role Editor)

tab_slug (<code>string</code>) — Modal tab slug

toggle_slug (<code>string</code>) — Modal tab settings group toggle slug

- default (<code>string</code>) — Default value
- description (<code>string</code>) — Description (localized)
- id (<code>string</code>) — CSS id for the setting’s field
- label (<code>string</code>) — Display name (localized)
- option_category (<code>string</code>) — Option category slug (for the Divi Role Editor)
- tab_slug (<code>string</code>) — Modal tab slug
- toggle_slug (<code>string</code>) — Modal tab settings group toggle slug

The Divi Builder has a comprehensive selection of field types for module settings. Below is a list of available field types, each with a screenshot and a list of any additional parameters that must be included in the setting definition.

The value to use for the <code>type</code> The parameter of the setting definition is in parenthesis next to each field type's name.

options (<code>array</code>) — Option slugs mapped to their display names (localized)

- options (<code>array</code>) — Option slugs mapped to their display names (localized)

options (<code>array</code>)

- off (<code>string</code>) — Display the name of the off-state (localized)
- on (<code>string</code>) — Display the name of the on-state (localized)

- options (<code>array</code>)
 - off (<code>string</code>) — Display the name of the off-state (localized)
 - on (<code>string</code>) — Display the name of the on-state (localized)

- min (<code>string</code>) — Minimum value
- max (<code>string</code>) — Maximum value
- step (<code>string</code>) — Minimum distance between values when using the slider

validate_unit (<code>bool</code>) — Whether or not to validate the unit.

- range_settings (array)
 - min (<code>string</code>) — Minimum value
 - max (<code>string</code>) — Maximum value
 - step (<code>string</code>) — Minimum distance between values when using the slider
- validate_unit (<code>bool</code>) — Whether or not to validate the unit.

Required Parameters

Optional Parameters

Field Types

Text (text)

Select (select)

Select Field Parameters

Checkboxes (multiple_checkboxes)

Checkboxes Field Parameters

Toggle Button (yes_no_button)

Toggle Button Field Parameters

Range Slider (range)

Range Slider Field Parameters