WidgetInterface

Interface definition for field widget plugins.

This interface details the methods that most plugin implementations will want to override. See Drupal\Core\Field\WidgetBaseInterface for base wrapping methods that should most likely be inherited directly from Drupal\Core\Field\WidgetBase..

Hierarchy

Related topics

Field Widget API
Define Field API widget types.

File

core/lib/Drupal/Core/Field/WidgetInterface.php, line 18

Namespace

Drupal\Core\Field

Members

Name Modifiers Type Description
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation.
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance.
PluginSettingsInterface::defaultSettings public static function Defines the default settings for this plugin.
PluginSettingsInterface::getSetting public function Returns the value of a setting, or its default value if absent.
PluginSettingsInterface::getSettings public function Returns the array of settings, including defaults for missing settings.
PluginSettingsInterface::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted.
PluginSettingsInterface::setSetting public function Sets the value of a setting for the plugin.
PluginSettingsInterface::setSettings public function Sets the settings for the plugin.
ThirdPartySettingsInterface::getThirdPartyProviders public function Gets the list of third parties that store information.
ThirdPartySettingsInterface::getThirdPartySetting public function Gets the value of a third-party setting.
ThirdPartySettingsInterface::getThirdPartySettings public function Gets all third-party settings of a given module.
ThirdPartySettingsInterface::setThirdPartySetting public function Sets the value of a third-party setting.
ThirdPartySettingsInterface::unsetThirdPartySetting public function Unsets a third-party setting.
WidgetBaseInterface::extractFormValues public function Extracts field values from submitted form values.
WidgetBaseInterface::flagErrors public function Reports field-level validation errors against actual form elements.
WidgetBaseInterface::form public function Creates a form element for a field.
WidgetBaseInterface::getWidgetState public static function Retrieves processing information about the widget from $form_state.
WidgetBaseInterface::setWidgetState public static function Stores processing information about the widget in $form_state.
WidgetInterface::errorElement public function Assigns a field-level validation error to the right widget sub-element.
WidgetInterface::formElement public function Returns the form for a single field widget.
WidgetInterface::isApplicable public static function Returns if the widget can be used for the provided field.
WidgetInterface::massageFormValues public function Massages the form values into the format expected for field values.
WidgetInterface::settingsForm public function Returns a form to configure settings for the widget.
WidgetInterface::settingsSummary public function Returns a short summary for the current widget settings.
doc_Drupal
2016-10-29 09:56:45
Comments
Leave a Comment

Please login to continue.