Skip to content

EntryTitleField

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

EntryTitleField represents a Title field that can be included within an entry type’s field layout designer.

View source

Public Properties

PropertyDescription
attributestring – The element attribute this field is for.
autocapitalizeboolean – Whether the input should support auto-capitalization.
autocompletestring, boolean, null – The input’s autocomplete attribute value.
autocorrectboolean – Whether the input should support autocorrect.
autofocusboolean – Whether the input should get an autofocus attribute.
classstring, string[], null – The input’s class attribute value.
containerAttributesarray – HTML attributes for the field container
disabledboolean – Whether the input should get a disabled attribute.
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.
maxinteger, null – The input’s max attribute value.
maxlengthinteger, null – The input’s maxlength attribute value.
mininteger, null – The input’s min attribute value.
namestring, null – The input’s name attribute value.
orientationstring, null – The field’s orientation (ltr or rtl)
placeholderstring, null – The input’s placeholder attribute value.
readonlyboolean – Whether the input should get a readonly attribute.
requirableboolean – Whether the field can optionally be marked as required.
requiredboolean – Whether the field is required.
sizeinteger, null – The input’s size attribute value.
stepinteger, null – The input’s step attribute value.
tipstring, null – The field’s tip text
titlestring, null – The input’s title attribute value.
translatableboolean – Whether the field is translatable
typestring – The input type
warningstring, null – The field’s warning text
widthinteger – The width (%) of the field

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.
defaultLabel()Returns the field’s default label, which will be used if label() is null.
extraFields()Returns the list of fields that can be expanded further and returned by toArray().
fields()Returns the list of fields that should be returned by default by toArray() when no specific fields are specified.
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.
inputHtml()Returns the field’s input HTML.
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.

inputHtml()

Returns the field’s input HTML.

View source

Arguments

Returns

string, null

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.
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.
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.

selectorInnerHtml()

Returns the selector’s inner HTML.

View source

Returns

string

translatable()

Returns whether the field is translatable.

View source

Arguments

Returns

boolean

translationDescription()

Returns the descriptive text for how this field is translatable.

View source

Arguments

Returns

string, null