FieldLayoutElementInterface

Type: Interface
Namespace: craft\base
Extends: yii\base\Arrayable (opens new window)
Implemented by: craft\base\FieldLayoutElement, craft\fieldlayoutelements\AssetTitleField, craft\fieldlayoutelements\BaseField, craft\fieldlayoutelements\BaseUiElement, craft\fieldlayoutelements\CustomField, craft\fieldlayoutelements\EntryTitleField, craft\fieldlayoutelements\Heading, craft\fieldlayoutelements\HorizontalRule, craft\fieldlayoutelements\StandardField, craft\fieldlayoutelements\StandardTextField, craft\fieldlayoutelements\Template, craft\fieldlayoutelements\Tip, craft\fieldlayoutelements\TitleField
Since: 3.5.0

FieldLayoutElementInterface defines the common interface to be implemented by field layout element classes.

# Public Methods

Method	Description
extraFields() (opens new window)	Returns the list of additional fields that can be returned by toArray() (opens new window) in addition to those listed in fields() (opens new window).
fields() (opens new window)	Returns the list of fields that should be returned by default by toArray() (opens new window) when no specific fields are specified.
formHtml()	Returns the element’s form HTMl.
hasCustomWidth()	Returns whether the element can have a custom width.
selectorHtml()	Returns the selector HTML that should be displayed within field layout designers.
settingsHtml()	Returns the settings HTML for the layout element.
toArray() (opens new window)	Converts the object into an array.

Returns the element’s form HTMl.

Return null if the element should not be present within the form.

$element (craft\base\ElementInterface, null (opens new window)) – The element the form is being rendered for
$static (boolean (opens new window)) – Whether the form should be static (non-interactive)