class Widget

Provides a widget element.

A form wrapper containing basic properties for the widget, attach the widget elements to this wrapper. This element renders to an empty string.

@property $field_parents The 'parents' space for the field in the form. Most widgets can simply overlook this property. This identifies the location where the field values are placed within $form_state->getValues(), and is used to access processing information for the field through the WidgetBase::getWidgetState() and WidgetBase::setWidgetState() methods. @property $delta The order of this item in the array of sub-elements. (0, 1, 2, etc.)

Attributes

#[RenderElement('widget')]

Hierarchy

Expanded class hierarchy of Widget

5 files declare their use of Widget
OEmbedWidget.php in core/modules/media/src/Plugin/Field/FieldWidget/OEmbedWidget.php
StringTextfieldWidget.php in core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/StringTextfieldWidget.php
TextfieldWidget.php in core/modules/text/src/Plugin/Field/FieldWidget/TextfieldWidget.php
WidgetBase.php in core/lib/Drupal/Core/Field/WidgetBase.php
WidgetInterface.php in core/lib/Drupal/Core/Field/WidgetInterface.php
10 string references to 'Widget'
claro_views_pre_render in core/themes/claro/claro.theme
Implements hook_views_pre_render().
d7_field_instance.yml in core/modules/field/migrations/d7_field_instance.yml
core/modules/field/migrations/d7_field_instance.yml
EntityFormDisplayEditForm::getTableHeader in core/modules/field_ui/src/Form/EntityFormDisplayEditForm.php
Returns an array containing the table headers.
MediaLibraryHooks::viewsPostRender in core/modules/media_library/src/Hook/MediaLibraryHooks.php
Implements hook_views_post_render().
MediaLibraryHooks::viewsPreRender in core/modules/media_library/src/Hook/MediaLibraryHooks.php
Implements hook_views_pre_render().

... See full list

File

core/lib/Drupal/Core/Render/Element/Widget.php, line 23

Namespace

Drupal\Core\Render\Element
View source
class Widget extends Generic {

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
Generic::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo
Generic::setType protected function Set type on initialize. Overrides RenderElementBase::setType
MessengerTrait::$messenger protected property The messenger. 25
MessengerTrait::messenger public function Gets the messenger. 25
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin ID.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 2
PluginBase::getPluginId public function Gets the plugin ID of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable Deprecated public function Determines if the plugin is configurable.
RenderElementBase::$renderParent protected property The parent element.
RenderElementBase::$renderParentName protected property The parent key.
RenderElementBase::$storage protected property The storage.
RenderElementBase::addChild public function Adds a child render element. Overrides ElementInterface::addChild
RenderElementBase::changeType public function Change the type of the element. Overrides ElementInterface::changeType
RenderElementBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 2
RenderElementBase::createChild public function Creates a render object and attaches it to the current render object. Overrides ElementInterface::createChild
RenderElementBase::elementInfoManager protected function Returns the element info manager.
RenderElementBase::getChild public function Gets a child. Overrides ElementInterface::getChild
RenderElementBase::getChildren public function Returns child elements. Overrides ElementInterface::getChildren
RenderElementBase::initializeInternalStorage public function Initialize storage. Overrides ElementInterface::initializeInternalStorage
RenderElementBase::preRenderAjaxForm public static function Adds Ajax information about an element to communicate with JavaScript. 2
RenderElementBase::preRenderGroup public static function Adds members of this group as actual elements for rendering. 2
RenderElementBase::processAjaxForm public static function Form element processing handler for the #ajax form property. 3
RenderElementBase::processGroup public static function Arranges elements into groups. 2
RenderElementBase::removeChild public function Removes a child. Overrides ElementInterface::removeChild
RenderElementBase::setAttributes public static function Sets a form element's class attribute. Overrides ElementInterface::setAttributes 2
RenderElementBase::toRenderable public function Returns a render array. Overrides ElementInterface::toRenderable
RenderElementBase::__construct public function Constructs a new render element object. Overrides PluginBase::__construct 6
RenderElementBase::__get public function Magic method: gets a property value.
RenderElementBase::__isset public function Magic method: checks if a property value is set.
RenderElementBase::__set public function Magic method: Sets a property value.
RenderElementBase::__sleep public function Overrides DependencySerializationTrait::__sleep
RenderElementBase::__unset public function Magic method: unsets a property value.
RenderElementBase::__wakeup public function Overrides DependencySerializationTrait::__wakeup
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language. 1

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.