Craft\UsersFieldType » Craft\BaseElementFieldType » Craft\BaseFieldType » Craft\BaseSavableComponentType » Craft\BaseComponentType » Craft\BaseApplicationComponent » CApplicationComponent » CComponent
Craft\IComponentType, Craft\IEagerLoadingFieldType, Craft\IFieldType, Craft\IPreviewableFieldType, Craft\ISavableComponentType, IApplicationComponent

Class UsersFieldType

See also

View source

Public Properties

$behaviorsarray – The behaviors that should be attached to this component.

Protected Properties



protected string $elementType = 'User'

Public Methods

__call()Calls the named method which is not a class method.
__get()Returns a property value, an event handler list or a behavior based on its name.
__isset()Checks if a property value is null.
__set()Sets value of a component property.
__unset()Sets a component property to be null.
asa()Returns the named behavior object.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
attachEventHandler()Attaches an event handler to an event.
canGetProperty()Determines whether a property can be read.
canSetProperty()Determines whether a property can be set.
defineContentAttribute()Returns the field’s content attribute config.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
detachEventHandler()Detaches an existing event handler.
disableBehavior()Disables an attached behavior.
disableBehaviors()Disables all behaviors attached to this component.
enableBehavior()Enables an attached behavior.
enableBehaviors()Enables all behaviors attached to this component.
evaluateExpression()Evaluates a PHP expression or callback under the context of this component.
getClassHandle()Returns the component’s handle, ideally based on the class name.
getEagerLoadingMap()Returns an array that maps source-to-target element IDs based on this custom field.
getEventHandlers()Returns the list of attached event handlers for an event.
getInputHtml()Returns the field’s input HTML.
getIsInitialized()Checks if this application component has been initialized.
getName()Returns the component’s name.
getSearchKeywords()Returns the search keywords that should be associated with this field.
getSettings()Returns the component’s settings model.
getSettingsHtml()Returns the component’s settings HTML.
getStaticHtml()Returns a static (non-editable) version of the field’s input HTML.
hasEvent()Determines whether an event is defined.
hasEventHandler()Checks whether the named event has attached handlers.
hasProperty()Determines whether a property is defined.
init()Initializes the application component.
isInitialized()Checks if this application component has been initialized yet, or not.
isSelectable()Returns whether this component should be shown when the user is creating a component of this type.
modifyElementsQuery()Modifies an element query.
onAfterDelete()Performs any actions after a field is deleted.
onAfterElementSave()Performs any additional actions after the element has been saved.
onAfterSave()Performs any actions after a field is saved.
onBeforeDelete()Performs any actions before a field is deleted.
onBeforeSave()Performs any actions before a field is saved.
prepSettings()Preps the settings before they’re saved to the database.
prepValue()Prepares the field’s value for use.
prepValueFromPost()Returns the input value as it should be stored in the database.
raiseEvent()Raises an event.
setElement()Sets the element that the field type is associated with.
setIsFresh()Sets whether the field is fresh.
setSettings()Sets the setting values.
validate()Validates the field’s value.

Protected Methods

defineSettings()Defines the settings.
getAddButtonLabel()Returns the label for the "Add" button.
getAvailableSources()Returns the sources that should be available to choose from within the field's settings
getContentPostLocation()Returns the location in POST that this field's content was pulled from.
getElementType()Returns the element type.
getInputSelectionCriteria()Returns any additional criteria parameters limiting which elements the field should be able to select.
getInputSources()Returns an array of the source keys the field should be able to select elements from.
getInputTemplateVariables()Returns an array of variables that should be passed to the input template.
getSettingsModel()Returns the settings model.
getSourceOptions()Normalizes the available sources into select input options.
getSupportedViewModes()Returns the field’s supported view modes.
getTargetLocale()Returns the locale that target elements should have.
getTargetLocaleFieldHtml()Returns the HTML for the Target Locale setting.
getViewMode()Returns the field’s current view mode.
getViewModeFieldHtml()Returns the HTML for the View Mode setting.
isFresh()Returns whether this is the first time the element's content has been edited.


Returns the label for the "Add" button.


View source




protected string getAddButtonLabel ( )