A Field object represents a form field of a particular type. Each field has its own unique attributes and functionality. Whenever you're dealing with a field in your template, you're actually working with a Field
object.
Attribute | Description |
---|---|
id | ID of the field. |
name | The name of the field. |
label | An alias to name . |
handle | The handle of the field. |
type | The type of the field. |
form | The Form this field belongs to. |
formId | The Form ID for the form this field belongs to. |
rowId | The Row ID for the row this field belongs to. |
rowIndex | The Row index for the row this field belongs to. This is used for field ordering. |
settings | A collection of settings for the field. See Field Settings. |
Method | Description |
---|---|
getSvgIcon() | Returns the contents of an SVG icon used for a field type. |
getSvgIconPath() | Returns the path to the SVG icon used for a field type. |
getIsNew() | Denotes whether this field is new. |
hasLabel() | Whether the field has a label or not. Some fields do not have one. |
renderLabel() | An alias to hasLabel() . |
getIsTextInput() | Whether this field is classified as a text input. |
getIsSelect() | Whether this field is classified as a select input. |
getIsFieldset() | Whether this field contains a fieldset. Normally, for when fields have sub-fields. |
getExtraBaseFieldConfig() | Returns any base-level configuration data for the field. |
getFieldDefaults() | Returns any defaults for the field, when it's created. |
getContainerAttributes() | Returns an array of options for container attributes. |
getInputAttributes() | Returns an array of options for input attributes. |
getFrontEndInputHtml() | Returns the HTML for a the front-end template for a field. |
getFrontEndInputOptions() | Returns an object of variables that can be used for front-end fields. |
getEmailHtml() | Returns the HTML for an email notification for a field. |
afterCreateField() | A function called after a field has been created in the control panel. |
The settings for a field will differ per-type, but the following are general settings applicable to all fields.
Attribute | Description |
---|---|
labelPosition | The position of the field's label. |
instructionsPosition | The position of the field's instructions. |
cssClasses | Any CSS classes, applied on the outer container of a field. |
containerAttributes | A collection of attributes added to the outer container of a field. |
inputAttributes | A collection of attributes added to the input element of a field - where applicable. |
Setting | Description |
---|---|
address1Label | The label for the Address 1 sub-field. |
address1Placeholder | The placeholder for the Address 1 sub-field. |
address1DefaultValue | The default value for the Address 1 sub-field. |
address1Required | Whether the Address 1 sub-field should be required. |
address1ErrorMessage | The error message for the Address 1 sub-field. |
address1Collapsed | Whether the Address 1 sub-field is collapsed in the control panel. |
address1Enabled | Whether the Address 1 sub-field is enabled in the control panel. |
address2Label | The label for the Address 2 sub-field. |
address2Placeholder | The placeholder for the Address 2 sub-field. |
address2DefaultValue | The default value for the Address 2 sub-field. |
address2Required | Whether the Address 2 sub-field should be required. |
address2ErrorMessage | The error message for the Address 2 sub-field. |
address2Collapsed | Whether the Address 2 sub-field is collapsed in the control panel. |
address2Enabled | Whether the Address 2 sub-field is enabled in the control panel. |
address3Label | The label for the Address 3 sub-field. |
address3Placeholder | The placeholder for the Address 3 sub-field. |
address3DefaultValue | The default value for the Address 3 sub-field. |
address3Required | Whether the Address 3 sub-field should be required. |
address3ErrorMessage | The error message for the Address 3 sub-field. |
address3Collapsed | Whether the Address 3 sub-field is collapsed in the control panel. |
address3Enabled | Whether the Address 3 sub-field is enabled in the control panel. |
cityLabel | The label for the City sub-field. |
cityPlaceholder | The placeholder for the City sub-field. |
cityDefaultValue | The default value for the City sub-field. |
cityRequired | Whether the City sub-field should be required. |
cityErrorMessage | The error message for the City sub-field. |
cityCollapsed | Whether the City sub-field is collapsed in the control panel. |
cityEnabled | Whether the City sub-field is enabled in the control panel. |
stateLabel | The label for the State sub-field. |
statePlaceholder | The placeholder for the State sub-field. |
stateDefaultValue | The default value for the State sub-field. |
stateRequired | Whether the State sub-field should be required. |
stateErrorMessage | The error message for the State sub-field. |
stateCollapsed | Whether the State sub-field is collapsed in the control panel. |
stateEnabled | Whether the State sub-field is enabled in the control panel. |
zipLabel | The label for the Zip sub-field. |
zipPlaceholder | The placeholder for the Zip sub-field. |
zipDefaultValue | The default value for the Zip sub-field. |
zipRequired | Whether the Zip sub-field should be required. |
zipErrorMessage | The error message for the Zip sub-field. |
zipCollapsed | Whether the Zip sub-field is collapsed in the control panel. |
zipEnabled | Whether the Zip sub-field is enabled in the control panel. |
countryLabel | The label for the Country sub-field. |
countryPlaceholder | The placeholder for the Country sub-field. |
countryDefaultValue | The default value for the Country sub-field. |
countryRequired | Whether the Country sub-field should be required. |
countryErrorMessage | The error message for the Country sub-field. |
countryCollapsed | Whether the Country sub-field is collapsed in the control panel. |
countryEnabled | Whether the Country sub-field is enabled in the control panel. |
Setting | Description |
---|---|
description | The description for the field. This will be shown next to the checkbox. |
checkedValue | The value of this field when it is checked. |
uncheckedValue | The value of this field when it is unchecked. |
defaultValue | The default value for the field when it loads. |
Setting | Description |
---|---|
placeholder | The option shown initially, when no option is selected. |
source | Which source do you want to select categories from? |
branchLimit | Limit the number of selectable category branches. |
Setting | Description |
---|---|
options | Define the available options for users to select from. |
layout | Select which layout to use for these fields. |
Setting | Description |
---|---|
includeTime | Whether this field should include the time. |
defaultValue | Entering a default value will place the value in the field when it loads. |
displayType | Set different display layouts for this field. |
Setting | Description |
---|---|
multiple | Whether this field should allow multiple options to be selected. |
options | Define the available options for users to select from. |
Setting | Description |
---|---|
placeholder | The text that will be shown if the field doesn’t have a value. |
defaultValue | Entering a default value will place the value in the field when it loads. |
Setting | Description |
---|---|
placeholder | The option shown initially, when no option is selected. |
sources | Which sources do you want to select entries from? |
limit | Limit the number of selectable entries. |
Setting | Description |
---|---|
uploadLocationSource | The volume for files to be uploaded into. |
uploadLocationSubpath | The sub-path for the files to be uploaded into. |
limitFiles | Limit the number of files a user can upload. |
sizeLimit | Limit the size of the files a user can upload. |
allowedKinds | A collection of allowed mime-types the user can upload. |
Setting | Description |
---|---|
headingSize | Choose the size for the heading. |
Setting | Description |
---|---|
defaultOption | The selected option for the preset default value chosen. |
defaultValue | Entering a default value will place the value in the field when it loads. This will be dependant on the value chosen for the defaultOption . |
queryParameter | If query string is selected for the defaultOption , this will contain the query string parameter to look up. |
Setting | Description |
---|---|
htmlContent | Enter HTML content to be rendered for this field. |
Setting | Description |
---|---|
placeholder | The text that will be shown if the field doesn’t have a value. |
defaultValue | Entering a default value will place the value in the field when it loads. |
limit | Whether to limit the content of this field. |
limitType | Either words or characters . |
limitAmount | The number of character or words to limit this field by. |
useRichText | Whether the front-end of the field should use a Rich Text editor. This is powered by Pell. |
richTextButtons | An array of available buttons the Rich Text field should use. Consult the Pell docs for these options. |
Setting | Description |
---|---|
useMultipleFields | Whether this field should use multiple fields for users to enter their details. |
prefixLabel | The label for the Prefix sub-field. |
prefixPlaceholder | The placeholder for the Prefix sub-field. |
prefixDefaultValue | The default value for the Prefix sub-field. |
prefixRequired | Whether the Prefix sub-field should be required. |
prefixErrorMessage | The error message for the Prefix sub-field. |
prefixCollapsed | Whether the Prefix sub-field is collapsed in the control panel. |
prefixEnabled | Whether the Prefix sub-field is enabled in the control panel. |
firstNameLabel | The label for the First Name sub-field. |
firstNamePlaceholder | The placeholder for the First Name sub-field. |
firstNameDefaultValue | The default value for the First Name sub-field. |
firstNameRequired | Whether the First Name sub-field should be required. |
firstNameErrorMessage | The error message for the First Name sub-field. |
firstNameCollapsed | Whether the First Name sub-field is collapsed in the control panel. |
firstNameEnabled | Whether the First Name sub-field is enabled in the control panel. |
middleNameLabel | The label for the Middle Name sub-field. |
middleNamePlaceholder | The placeholder for the Middle Name sub-field. |
middleNameDefaultValue | The default value for the Middle Name sub-field. |
middleNameRequired | Whether the Middle Name sub-field should be required. |
middleNameErrorMessage | The error message for the Middle Name sub-field. |
middleNameCollapsed | Whether the Middle Name sub-field is collapsed in the control panel. |
middleNameEnabled | Whether the Middle Name sub-field is enabled in the control panel. |
lastNameLabel | The label for the Last Name sub-field. |
lastNamePlaceholder | The placeholder for the Last Name sub-field. |
lastNameDefaultValue | The default value for the Last Name sub-field. |
lastNameRequired | Whether the Last Name sub-field should be required. |
lastNameErrorMessage | The error message for the Last Name sub-field. |
lastNameCollapsed | Whether the Last Name sub-field is collapsed in the control panel. |
lastNameEnabled | Whether the Last Name sub-field is enabled in the control panel. |
Setting | Description |
---|---|
placeholder | The text that will be shown if the field doesn’t have a value. |
defaultValue | Entering a default value will place the value in the field when it loads. |
limit | Whether to limit the numbers for this field. |
min | The minimum number that can be entered for this field. |
max | The maximum number that can be entered for this field. |
decimals | Set the number of decimal points to format the field value. |
Setting | Description |
---|---|
showCountryCode | Whether to show an additional dropdown for selecting the country code. |
countryLabel | The label for the Country sub-field. |
countryPlaceholder | The placeholder for the Country sub-field. |
countryDefaultValue | The default value for the Country sub-field. |
countryCollapsed | Whether the Country sub-field is collapsed in the control panel. |
countryEnabled | Whether the Country sub-field is enabled in the control panel. |
numberLabel | The label for the Number sub-field. |
numberPlaceholder | The placeholder for the Number sub-field. |
numberDefaultValue | The default value for the Number sub-field. |
numberCollapsed | Whether the Number sub-field is collapsed in the control panel. |
Setting | Description |
---|---|
placeholder | The option shown initially, when no option is selected. |
sources | Which sources do you want to select products from? |
limit | Limit the number of selectable products. |
Setting | Description |
---|---|
options | Define the available options for users to select from. |
layout | Select which layout to use for these fields. |
Setting | Description |
---|---|
addLabel | The label for the button that adds another instance. |
minRows | The minimum required number of instances of this repeater's fields that must be completed. |
maxRows | The maximum required number of instances of this repeater's fields that must be completed. |
Setting | Description |
---|---|
displayType | What sort of field to show on the front-end for users. |
options | Define the available options for users to select from. |
Setting | Description |
---|---|
border | Add a border to this section. |
borderWidth | Set the border width (in pixels). |
borderColor | Set the border color. |
Setting | Description |
---|---|
placeholder | The text that will be shown if the field doesn’t have a value. |
defaultValue | Entering a default value will place the value in the field when it loads. |
limit | Whether to limit the content of this field. |
limitType | Either words or characters . |
limitAmount | The number of character or words to limit this field by. |
Setting | Description |
---|---|
columns | Define the columns your table should have. |
defaults | Define the default values for the field. |
addRowLabel | The label for the button that adds another row. |
static | Whether this field should disallow adding more rows, showing only the default rows. |
minRows | The minimum required number of rows in this table that must be completed. |
maxRows | The maximum required number of rows in this table that must be completed. |
Setting | Description |
---|---|
placeholder | The option shown initially, when no option is selected. |
source | Which source do you want to select tags from? |
Setting | Description |
---|---|
placeholder | The option shown initially, when no option is selected. |
sources | Which sources do you want to select users from? |
limit | Limit the number of selectable users. |
Setting | Description |
---|---|
placeholder | The option shown initially, when no option is selected. |
source | Which source do you want to select variants from? |
limit | Limit the number of selectable variants. |
← Row Submission →
Available for Craft 3. Get it from the plugin store.