Skip to content

StandardField

Type
Abstract Class
Namespace
craft\fieldlayoutelements
Inherits
craft\fieldlayoutelements\StandardField » craft\fieldlayoutelements\BaseField » craft\base\FieldLayoutElement » yii\base\BaseObject
Implements
craft\base\FieldLayoutElementInterface, yii\base\Configurable
Uses traits
yii\base\ArrayableTrait
Extended by
craft\fieldlayoutelements\AssetTitleField, craft\fieldlayoutelements\EntryTitleField, craft\fieldlayoutelements\StandardTextField, craft\fieldlayoutelements\TitleField
Since
3.5.0

StandardField is the base class for standard fields that can be included in field layouts.

Standard fields can be registered using craft\models\FieldLayout::EVENT_DEFINE_STANDARD_FIELDS.

View source

Public Properties

PropertyDescription
attributestring – The element attribute this field is for.
containerAttributesarray – HTML attributes for the field container
idstring, null – The input’s id attribute value.
inputContainerAttributesarray – HTML attributes for the input container
instructionsstring, null – The field’s instructions
labelstring, null – The field’s label
labelAttributesstring, null – The ID of the field label
mandatoryboolean – Whether the field must be present within the layout.
orientationstring, null – The field’s orientation (ltr or rtl)
requirableboolean – Whether the field can optionally be marked as required.
requiredboolean – Whether the field is required.
tipstring, null – The field’s tip text
translatableboolean – Whether the field is translatable
warningstring, null – The field’s warning text
widthinteger – The width (%) of the field

attribute

Type
string
Default value
null

The element attribute this field is for.

View source

containerAttributes

Type
array
Default value
[]

HTML attributes for the field container

View source

id

Type
string, null
Default value
null

The input’s id attribute value.

View source

inputContainerAttributes

Type
array
Default value
[]

HTML attributes for the input container

View source

labelAttributes

Type
string, null
Default value
[]

The ID of the field label

View source

mandatory

Type
boolean
Default value
false

Whether the field must be present within the layout.

View source

orientation

Type
string, null
Default value
null

The field’s orientation (ltr or rtl)

View source

requirable

Type
boolean
Default value
false

Whether the field can optionally be marked as required.

View source

translatable

Type
boolean
Default value
false

Whether the field is translatable

View source

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__construct()Constructor.
__get()Returns the value of an object property.
__isset()Checks if a property is set, i.e. defined and not null.
__set()Sets value of an object property.
__unset()Sets an object property to null.
attribute()Returns the element attribute this field is for.
canGetProperty()Returns a value indicating whether a property can be read.
canSetProperty()Returns a value indicating whether a property can be set.
className()Returns the fully qualified name of this class.
extraFields()Returns the list of fields that can be expanded further and returned by toArray().
fields()
formHtml()Returns the element’s form HTMl.
hasCustomWidth()Returns whether the element can have a custom width.
hasMethod()Returns a value indicating whether a method is defined.
hasProperty()Returns a value indicating whether a property is defined.
init()Initializes the object.
keywords()Returns the search keywords for this layout element.
label()Returns the field’s label.
mandatory()Returns whether the field must be present within the layout.
requirable()Returns whether the field can optionally be marked as required.
selectorHtml()Returns the selector HTML that should be displayed within field layout designers.
settingsHtml()Returns the settings HTML for the layout element.
toArray()Converts the model into an array.

attribute()

Returns the element attribute this field is for.

View source

Returns

string

mandatory()

Returns whether the field must be present within the layout.

View source

Returns

boolean

requirable()

Returns whether the field can optionally be marked as required.

View source

Returns

boolean

Protected Methods

MethodDescription
containerAttributes()Returns the element container HTML attributes.
defaultInstructions()Returns the field’s default instructions, which will be used if instructions() is null.
defaultLabel()Returns the field’s default label, which will be used if label() is null.
describedBy()Returns the aria-describedby attribute value that should be set on the focusable input(s).
errors()Returns the field’s validation errors.
errorsId()Returns the id of the field errors.
extractFieldsFor()Extract nested fields from a fields collection for a given root field Nested fields are separated with dots (.). e.g: "item.id" The previous example would extract "id".
extractRootFields()Extracts the root field names from nested fields.
id()Returns the id of the input.
inputContainerAttributes()Returns input container HTML attributes.
inputHtml()Returns the field’s input HTML.
instructions()Returns the field’s instructions.
instructionsId()Returns the id of the field instructions.
labelAttributes()Returns label HTML attributes.
orientation()Returns the field’s orientation (ltr or rtl).
resolveFields()Determines which fields can be returned by toArray().
selectorAttributes()Returns HTML attributes that should be added to the selector container.
selectorInnerHtml()Returns the selector’s inner HTML.
showLabel()Returns whether the label should be shown in form inputs.
statusClass()Returns the field’s status class.
statusId()Returns the id if the field status message.
statusLabel()Returns the field’s status label.
tip()Returns the field’s tip text.
tipId()Returns the id of the field tip.
translatable()Returns whether the field is translatable.
translationDescription()Returns the descriptive text for how this field is translatable.
useFieldset()Returns whether the element’s form HTML should use a <fieldset> + <legend> instead of a <div> + <label>.
value()Returns the field’s value.
warning()Returns the field’s warning text.
warningId()Returns the id of the field warning.

containerAttributes()

Returns the element container HTML attributes.

View source

Arguments

Returns

array

id()

Returns the id of the input.

View source

Returns

string

inputContainerAttributes()

Returns input container HTML attributes.

View source

Arguments

Returns

array

labelAttributes()

Returns label HTML attributes.

View source

Arguments

Returns

array

orientation()

Returns the field’s orientation (ltr or rtl).

View source

Arguments

Returns

string

tip()

Returns the field’s tip text.

View source

Arguments

Returns

string, null

translatable()

Returns whether the field is translatable.

View source

Arguments

Returns

boolean

warning()

Returns the field’s warning text.

View source

Arguments

Returns

string, null