FormBuilderField class

Maintains configuration for a field in a Form Builder form.

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the FormBuilderField class also inherits all the methods and properties of: FormBuilderData.

Retrieval

Name	Return	Summary
FormBuilderField::child() FormBuilderField::child(string $name) FormBuilderField::child(string $name)	`FormBuilderField` `null`	Return the direct child given by $name
FormBuilderField::children() FormBuilderField::children() FormBuilderField::children()	`array`	Return array of all children Can also be used as property: FormBuilderField::children
FormBuilderField::exists() FormBuilderField::exists(string $name) FormBuilderField::exists(string $name)	`bool`	Does field with this name exist?
FormBuilderField::fbForm() FormBuilderField::fbForm() FormBuilderField::fbForm()	`FormBuilderForm` `null`	Get the current FormBuilderForm instance for this field
FormBuilderField::getArray() FormBuilderField::getArray() FormBuilderField::getArray()	`array`	Return an array representing this field and children (when present)
FormBuilderField::getChildrenFlat() FormBuilderField::getChildrenFlat() FormBuilderField::getChildrenFlat(array $options = [])	`array`	Return a flattened (non structured) array of all children
FormBuilderField::getFieldByName() FormBuilderField::getFieldByName(string $name) FormBuilderField::getFieldByName(string $name)	`FormBuilderField` `null`	Get a field by name, within entire form
FormBuilderField::getInputfield() FormBuilderField::getInputfield() FormBuilderField::getInputfield(array $options = [])	`Inputfield`	Get new Inputfield for this FormBuilderField (for public API usage)
FormBuilderField::getSetting() FormBuilderField::getSetting(string $key) FormBuilderField::getSetting(string $key)	`mixed` `null`	Get a setting value only (no fallback to getting field by name)

Manipulation

Name	Return	Summary
FormBuilderField::add() FormBuilderField::add(FormBuilderField $child) FormBuilderField::add(FormBuilderField $child)	`self`	Add a new child as a FormBuilderField to this form or fieldset
FormBuilderField::addField() FormBuilderField::addField(string $name) FormBuilderField::addField(string $name, string $type = '', string $label = '', array $options = [])	`FormBuilderField`	Add new field by specifying name, type and label
FormBuilderField::remove() FormBuilderField::remove($key) FormBuilderField::remove($key)	`FormBuilderData` `this`	Remove the given child from this form/field
FormBuilderField::setName() FormBuilderField::setName(string $name) FormBuilderField::setName(string $name)	`FormBuilderData`	Set field name

Properties

Name	Return	Summary
FormBuilderField::columnWidth	`int`	Width of this field as a percent between 10 and 100.
FormBuilderField::defaultValue	`string`	Default value of this field (if applicable)
FormBuilderField::description	`string`	Optional description of field
FormBuilderField::form	`FormBuilderForm`	Form instance that this filed is connected with
FormBuilderField::formName	`string`	Name of the form this field belongs to
FormBuilderField::label	`string`	Label for this field
FormBuilderField::name	`string`	Name of field
FormBuilderField::notes	`string`	Optional notes for field
FormBuilderField::numChildren	`int`	Number of children this field has (if this field is a fieldset or form)
FormBuilderField::parent	`FormBuilderField` `FormBuilderForm` `null`	Parent of this field
FormBuilderField::required	`bool`	Is this field required?
FormBuilderField::requiredIf	`string`	Selector condition when field is required, also requires that 'required' is true.
FormBuilderField::showIf	`string`	Selector condition of when field is visible.
FormBuilderField::type	`string`	Type of field

Additional methods and properties

In addition to the methods and properties above, FormBuilderField also inherits the methods and properties of these classes:

FormBuilderData

API reference based on ProcessWire core version 3.0.252