Skip to main content

Field settings

Each field contains settings to determine where and how data is loaded and saved. All fields share some common settings, but also offer unique settings per field type. There are also settings from extensions which are explained on each extension docs.

Below is the list of common field settings with a brief description. The keys are for reference in code.

general settings

NameKeyDescription
LabelnameField label. Optional. If empty, the field input is 100% width.
IDidField ID. Required and must be unique. It will be used as meta_key when saving to the database. Use only numbers, letters, and underscores (and rarely dashes).
TypetypeField type. Required.
Label descriptionlabel_descriptionLabel description, displayed below the field label. Optional.
Input descriptiondescField description, displayed below the field input. Optional.
Default valuestdDefault value. Optional.
PlaceholderplaceholderPlaceholder text for the input or select box. Optional.
RequiredrequiredWhether the field is required (true or false). Optional. Default false.
DisableddisabledWhether the field is disabled (true or false). Optional. Default false.
Read onlyreadonlyWhether the field is read only (true or false). Optional. Default false.
MultiplemultipleDoes the field have multiple values (like the select field)? Optional. Default false.
CloneablecloneIs the field clonable (repeatable)? true or false. Optional. Default false.
Sortablesort_cloneAbility to drag-and-drop reorder clones (true or false). Optional. Default false.
Clone default valueclone_defaultClone the default value of fields? true or false (default).
Clone as multipleclone_as_multipleWhether to store clone values in multiple rows in the database? Optional. Default false.
Max number of clonesmax_cloneMaximum number of clones. Optional. Default 0 (unlimited).
Min number of clonesmin_cloneMinimum number of clones. Optional. Default 0.
Add more textadd_buttonThe text for Add more clone button. Optional. Default "+ Add more".
Hide from front endhide_from_frontWhether to hide the field from front-end submission forms. Required the MB Frontend Submission extension to work.
Hide from REST APIhide_from_restWhether to hide the field from REST API responses. Required the MB REST API extension to work.