craft\fields\MultiSelect » craft\fields\BaseOptionsField » craft\base\Field » craft\base\SavableComponent » craft\base\Component » craft\base\Model » yii\base\Model » yii\base\Component » yii\base\BaseObject
ArrayAccess, IteratorAggregate, craft\base\ComponentInterface, craft\base\FieldInterface, craft\base\PreviewableFieldInterface, craft\base\SavableComponentInterface, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface
Uses traits
craft\base\ClonefixTrait, craft\base\FieldTrait, craft\base\SavableComponentTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait

MultiSelect represents a Multi-select field.

View source

Public Properties

activeValidatorsyii\validators\Validator – The validators applicable to the current scenario.
attributesarray – Attribute values (name => value).
behaviorsyii\base\Behavior – List of behaviors attached to this component
columnPrefixstring, null – The field’s content column prefix
contentColumnTypestring – The column type.
contentGqlType\GraphQL\Type\Definition\Type, array
contextstring, null – The field’s context
dateCreatedDateTime, null – The date that the component was created
dateUpdatedDateTime, null – The date that the component was last updated
eagerLoadingGqlConditionsarray, false
errorsarray – Errors for all attributes or the specified attribute.
firstErrorsarray – The first errors.
groupcraft\records\FieldGroup, null
groupIdinteger, null – The field’s group’s ID
handlestring, null – The field’s handle
idinteger, string, null – The component’s ID (could be a temporary one: "new:X")
instructionsstring, null – The field’s instructions
isNewboolean – Whether the component is new
iteratorArrayIterator – An iterator for traversing the items in the list.
layoutIdinteger, null – The ID of the field layout that the field was fetched from
multiboolean – Whether the field should support multiple selections
namestring, null – The field’s name
oldHandlestring, null – The field’s previous handle
oldSettingsarray, null – The field’s previous settings
optgroupsboolean – Whether the field should support optgroups
optionsarray, null – The available options
requiredboolean, null – Whether the field is required in the field layout it was fetched from
scenariostring – The scenario that this model is in.
searchableboolean – Whether the field's values should be registered as search keywords on the elements.
settingsarray – The component’s settings.
settingsHtmlstring, null
sortOrderinteger, null – The field’s sort position in the field layout it was fetched from
tabIdinteger, null – The tab ID of the field layout that the field was fetched from
translationDescriptionstring, null
translationKeyFormatstring, null – The field’s translation key format, if translationMethod is "custom"
translationMethodstring – The field’s translation method
uidstring, null – The field's UID
validatorsArrayObject, yii\validators\Validator – All the validators declared in the model.



Whether the field should support multiple selections

View source



Whether the field should support optgroups

View source

Public Methods

__call()Calls the named method which is not a class method.
__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.
__toString()Use the translated field name as the string representation.
__unset()Sets an object property to null.
activeAttributes()Returns the attribute names that are subject to validation in the current scenario.
addError()Adds a new error to the specified attribute.
addErrors()Adds a list of errors.
addModelErrors()Adds errors from another model, with a given attribute name prefix.
afterDelete()Performs actions after a component is deleted.
afterElementDelete()Performs actions after the element has been deleted.
afterElementPropagate()Performs actions after the element has been fully saved and propagated to other sites.
afterElementRestore()Performs actions after the element has been restored.
afterElementSave()Performs actions after the element has been saved.
afterSave()Performs actions after a component is saved.
afterValidate()This method is invoked after validation ends.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
attributeHints()Returns the attribute hints.
attributeLabels()Returns the attribute labels.
attributes()Returns the list of attribute names.
beforeApplyDelete()Performs actions before a component delete is applied to the database.
beforeDelete()Performs actions before a component is deleted.
beforeElementDelete()Performs actions before an element is deleted.
beforeElementRestore()Performs actions before an element is restored.
beforeElementSave()Performs actions before an element is saved.
beforeSave()Performs actions before a component is saved.
beforeValidate()This method is invoked before validation starts.
behaviors()Returns a list of behaviors that this component should behave as.
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.
clearErrors()Removes errors for all attributes or a single attribute.
createValidators()Creates validator objects based on the validation rules specified in rules().
datetimeAttributes()Returns the names of any attributes that should hold DateTime values.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
displayName()Returns the display name of this class.
ensureBehaviors()Makes sure that the behaviors declared in behaviors() are attached to this component.
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.
formName()Returns the form name that this model class should use.
generateAttributeLabel()Generates a user friendly attribute label based on the give attribute name.
getActiveValidators()Returns the validators applicable to the current scenario.
getAttributeHint()Returns the text hint for the specified attribute.
getAttributeLabel()Returns the text label for the specified attribute.
getAttributes()Returns attribute values.
getBehavior()Returns the named behavior object.
getBehaviors()Returns all behaviors attached to this component.
getContentColumnType()Returns the column type that this field should get within the content table.
getContentGqlType()Returns the GraphQL type to be used for this field type.
getEagerLoadingGqlConditions()Returns an array that lists the scopes this custom field allows when eager-loading or false if eager-loading should not be allowed in the GraphQL context.
getElementValidationRules()Returns the validation rules for an element with this field.
getError()Returns the first error of the specified attribute.
getErrorSummary()Returns the errors for all attributes as a one-dimensional array.
getErrors()Returns the errors for all attributes or a single attribute.
getFirstError()Returns the first error of the specified attribute.
getFirstErrors()Returns the first error of every attribute in the model.
getGroup()Returns the field’s group.
getInputHtml()Returns the field’s input HTML.
getIsMultiOptionsField()Returns whether the field type supports storing multiple selected options.
getIsNew()Returns whether the component is new (unsaved).
getIsTranslatable()Returns whether the field should be shown as translatable in the UI.
getIterator()Returns an iterator for traversing the attributes in the model.
getScenario()Returns the scenario that this model is used in.
getSearchKeywords()Returns the search keywords that should be associated with this field.
getSettings()Returns an array of the component’s settings.
getSettingsHtml()Returns the component’s settings HTML.
getSortOption()Returns the sort option array that should be included in the element’s sortOptions() response.
getStaticHtml()Returns a static (non-editable) version of the field’s input HTML.
getTableAttributeHtml()Returns the HTML that should be shown for this field in Table View.
getTranslationDescription()Returns the description of this field’s translation support.
getTranslationKey()Returns the field’s translation key, based on a given element.
getValidators()Returns all the validators declared in rules().
hasContentColumn()Returns whether this field has a column in the content table.
hasErrors()Returns a value indicating whether there is any validation error.
hasEventHandlers()Returns a value indicating whether there is any handler attached to the named event.
hasMethod()Returns a value indicating whether a method is defined.
hasProperty()Returns a value indicating whether a property is defined.
init()Initializes the object.
instance()Returns static class instance, which can be used to obtain meta information.
isAttributeActive()Returns a value indicating whether the attribute is active in the current scenario.
isAttributeRequired()Returns a value indicating whether the attribute is required.
isAttributeSafe()Returns a value indicating whether the attribute is safe for massive assignments.
isSelectable()Returns whether the component should be selectable in component Type selects.
isValueEmpty()Returns whether the given value should be considered “empty” to a validator.
load()Populates the model with input data.
loadMultiple()Populates a set of models with the data from end user.
modifyElementIndexQuery()Modifies an element index query.
modifyElementsQuery()Modifies an element query.
normalizeValue()Normalizes the field’s value for use.
off()Detaches an existing event handler from this component.
offsetExists()Returns whether there is an element at the specified offset.
offsetGet()Returns the element at the specified offset.
offsetSet()Sets the element at the specified offset.
offsetUnset()Sets the element value at the specified offset to null.
on()Attaches an event handler to an event.
onUnsafeAttribute()This method is invoked when an unsafe attribute is being massively assigned.
rules()Returns the validation rules for attributes.
safeAttributes()Returns the attribute names that are safe to be massively assigned in the current scenario.
scenarios()Returns a list of scenarios and the corresponding active attributes.
serializeValue()Prepares the field’s value to be stored somewhere, like the content table or JSON-encoded in an entry revision table.
setAttributes()Sets the attribute values in a massive way.
setIsFresh()Sets whether the field is fresh.
setScenario()Sets the scenario for the model.
settingsAttributes()Returns the list of settings attribute names.
supportedTranslationMethods()Returns which translation methods the field supports.
toArray()Converts the model into an array.
trigger()Triggers an event.
validate()Validates the component.
validateMultiple()Validates multiple models.
validateOptions()Validates the field options.
valueType()Returns the PHPDoc type this field’s values will have.


Returns the display name of this class.

View source


string – The display name of this class.


Returns the field’s input HTML.

An extremely simple implementation would be to directly return some HTML:

return '<textarea name="'.$name.'">'.$value.'</textarea>';

For more complex inputs, you might prefer to create a template, and render it via craft\web\View::renderTemplate(). For example, the following code would render a template located at path/to/myplugin/templates/_fieldinput.html, passing the $name and $value variables to it:

return Craft::$app->view->renderTemplate('myplugin/_fieldinput', [
    'name'  => $name,
    'value' => $value

If you need to tie any JavaScript code to your input, it’s important to know that any name= and id= attributes within the returned HTML will probably get namespaced, however your JavaScript code will be left untouched. For example, if getInputHtml() returns the following HTML:

<textarea id="foo" name="foo"></textarea>
<script type="text/javascript">
    var textarea = document.getElementById('foo');

…then it might actually look like this before getting output to the browser:

<textarea id="namespace-foo" name="namespace[foo]"></textarea>
<script type="text/javascript">
    var textarea = document.getElementById('foo');

As you can see, that JavaScript code will not be able to find the textarea, because the textarea’s id= attribute was changed from foo to namespace-foo. Before you start adding namespace- to the beginning of your element ID selectors, keep in mind that the actual namespace is going to change depending on the context. Often they are randomly generated. So it’s not quite that simple.

Thankfully, craft\web\View provides a couple handy methods that can help you deal with this:

So here’s what a getInputHtml() method that includes field-targeting JavaScript code might look like:

public function getInputHtml($value, $element)
    // Come up with an ID value based on $name
    $id = Craft::$app->view->formatInputId($name);
    // Figure out what that ID is going to be namespaced into
    $namespacedId = Craft::$app->view->namespaceInputId($id);
    // Render and return the input template
    return Craft::$app->view->renderTemplate('myplugin/_fieldinput', [
        'name'         => $name,
        'id'           => $id,
        'namespacedId' => $namespacedId,
        'value'        => $value

And the _fieldinput.html template might look like this:

<textarea id="{{ id }}" name="{{ name }}">{{ value }}</textarea>
<script type="text/javascript">
    var textarea = document.getElementById('{{ namespacedId }}');

The same principles also apply if you’re including your JavaScript code with craft\web\View::registerJs().

View source


  • $value (mixed) – The field’s value. This will either be the normalized value, raw POST data (i.e. if there was a validation error), or null
  • $element (craft\base\ElementInterface, null) – The element the field is associated with, if there is one


string – The input HTML.



Returns the PHPDoc type this field’s values will have.

It will be used by the generated CustomFieldBehavior class.

If the values can be of more than one type, return multiple types separated by |s.

public static function phpDocType()
     return 'int|mixed|\\craft\\elements\\db\\ElementQuery';

View source



Protected Methods

defaultValue()Returns the default field value.
defineRules()Returns the validation rules for attributes.
extractFieldsFor()Extract nested fields from a fields collection for a given root field Nested fields are separated with dots (.). e.g: "" The previous example would extract "id".
extractRootFields()Extracts the root field names from nested fields.
isFresh()Returns whether this is the first time the element's content has been edited.
optionLabel()Returns an option's label by its value.
optionsSettingLabel()Returns the label for the Options setting.
requestParamName()Returns the field’s param name on the request.
resolveFields()Determines which fields can be returned by toArray().
translatedOptions()Returns the field options, with labels run through Craft::t().


Returns the label for the Options setting.

View source




SCENARIO_DEFAULTThe name of the default scenario.