class FormElement

Same name in this branch
  1. 11.x core/lib/Drupal/Core/Render/Annotation/FormElement.php \Drupal\Core\Render\Annotation\FormElement
  2. 11.x core/lib/Drupal/Core/Render/Attribute/FormElement.php \Drupal\Core\Render\Attribute\FormElement
Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/Render/Element/FormElement.php \Drupal\Core\Render\Element\FormElement
  2. 9 core/lib/Drupal/Core/Render/Annotation/FormElement.php \Drupal\Core\Render\Annotation\FormElement
  3. 8.9.x core/lib/Drupal/Core/Render/Element/FormElement.php \Drupal\Core\Render\Element\FormElement
  4. 8.9.x core/lib/Drupal/Core/Render/Annotation/FormElement.php \Drupal\Core\Render\Annotation\FormElement
  5. 10 core/lib/Drupal/Core/Render/Element/FormElement.php \Drupal\Core\Render\Element\FormElement
  6. 10 core/lib/Drupal/Core/Render/Annotation/FormElement.php \Drupal\Core\Render\Annotation\FormElement
  7. 10 core/lib/Drupal/Core/Render/Attribute/FormElement.php \Drupal\Core\Render\Attribute\FormElement

Provides a base class for form element plugins.

Hierarchy

Expanded class hierarchy of FormElement

Deprecated

in drupal:10.3.0 and is removed from drupal:12.0.0. use \Drupal\Core\Render\Element\FormElementBase instead.

See also

https://www.drupal.org/node/3436275

1 file declares its use of FormElement
DeprecatedExtendsFormElement.php in core/modules/system/tests/modules/element_info_test/src/Element/DeprecatedExtendsFormElement.php

File

core/lib/Drupal/Core/Render/Element/FormElement.php, line 15

Namespace

Drupal\Core\Render\Element
View source
abstract class FormElement extends FormElementBase {
    
    /**
     * {@inheritdoc}
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition) {
        parent::__construct($configuration, $plugin_id, $plugin_definition);
        @trigger_error('\\Drupal\\Core\\Render\\Element\\FormElement is deprecated in drupal:10.3.0 and is removed from drupal:12.0.0. Use \\Drupal\\Core\\Render\\Element\\FormElementBase instead. See https://www.drupal.org/node/3436275', E_USER_DEPRECATED);
    }
    
    /**
     * {@inheritdoc}
     */
    public static function setAttributes(&$element, $class = []) {
        @trigger_error('\\Drupal\\Core\\Render\\Element\\FormElement::setAttributes() is deprecated in drupal:10.3.0 and is removed from drupal:12.0.0. Use \\Drupal\\Core\\Render\\Element\\FormElementBase::setAttributes() instead. See https://www.drupal.org/node/3436275', E_USER_DEPRECATED);
        parent::setAttributes($element, $class);
    }
    
    /**
     * {@inheritdoc}
     */
    public static function preRenderGroup($element) {
        @trigger_error('\\Drupal\\Core\\Render\\Element\\FormElement::preRenderGroup() is deprecated in drupal:10.3.0 and is removed from drupal:12.0.0. Use \\Drupal\\Core\\Render\\Element\\FormElementBase::preRenderGroup() instead. See https://www.drupal.org/node/3436275', E_USER_DEPRECATED);
        return parent::preRenderGroup($element);
    }
    
    /**
     * {@inheritdoc}
     */
    public static function processAjaxForm(&$element, FormStateInterface $form_state, &$complete_form) {
        @trigger_error('\\Drupal\\Core\\Render\\Element\\FormElement::processAjaxForm() is deprecated in drupal:10.3.0 and is removed from drupal:12.0.0. Use \\Drupal\\Core\\Render\\Element\\FormElementBase::processAjaxForm() instead. See https://www.drupal.org/node/3436275', E_USER_DEPRECATED);
        return parent::processAjaxForm($element, $form_state, $complete_form);
    }
    
    /**
     * {@inheritdoc}
     */
    public static function preRenderAjaxForm($element) {
        @trigger_error('\\Drupal\\Core\\Render\\Element\\FormElement::preRenderAjaxForm() is deprecated in drupal:10.3.0 and is removed from drupal:12.0.0. Use \\Drupal\\Core\\Render\\Element\\FormElementBase::preRenderAjaxForm() instead. See https://www.drupal.org/node/3436275', E_USER_DEPRECATED);
        return parent::preRenderAjaxForm($element);
    }
    
    /**
     * {@inheritdoc}
     */
    public static function processGroup(&$element, FormStateInterface $form_state, &$complete_form) {
        @trigger_error('\\Drupal\\Core\\Render\\Element\\FormElement::processGroup() is deprecated in drupal:10.3.0 and is removed from drupal:12.0.0. Use \\Drupal\\Core\\Render\\Element\\FormElementBase::processGroup() instead. See https://www.drupal.org/node/3436275', E_USER_DEPRECATED);
        return parent::processGroup($element, $form_state, $complete_form);
    }
    
    /**
     * {@inheritdoc}
     */
    public static function valueCallback(&$element, $input, FormStateInterface $form_state) {
        @trigger_error('\\Drupal\\Core\\Render\\Element\\FormElement::valueCallback() is deprecated in drupal:10.3.0 and is removed from drupal:12.0.0. Use \\Drupal\\Core\\Render\\Element\\FormElementBase::valueCallback() instead. See https://www.drupal.org/node/3436275', E_USER_DEPRECATED);
        return parent::valueCallback($element, $input, $form_state);
    }
    
    /**
     * {@inheritdoc}
     */
    public static function processPattern(&$element, FormStateInterface $form_state, &$complete_form) {
        @trigger_error('\\Drupal\\Core\\Render\\Element\\FormElement::processPattern() is deprecated in drupal:10.3.0 and is removed from drupal:12.0.0. Use \\Drupal\\Core\\Render\\Element\\FormElementBase::processPattern() instead. See https://www.drupal.org/node/3436275', E_USER_DEPRECATED);
        return parent::processPattern($element, $form_state, $complete_form);
    }
    
    /**
     * {@inheritdoc}
     */
    public static function validatePattern(&$element, FormStateInterface $form_state, &$complete_form) {
        @trigger_error('\\Drupal\\Core\\Render\\Element\\FormElement::validatePattern() is deprecated in drupal:10.3.0 and is removed from drupal:12.0.0. Use \\Drupal\\Core\\Render\\Element\\FormElementBase::validatePattern() instead. See https://www.drupal.org/node/3436275', E_USER_DEPRECATED);
        parent::validatePattern($element, $form_state, $complete_form);
    }
    
    /**
     * {@inheritdoc}
     */
    public static function processAutocomplete(&$element, FormStateInterface $form_state, &$complete_form) {
        @trigger_error('\\Drupal\\Core\\Render\\Element\\FormElement::processAutocomplete() is deprecated in drupal:10.3.0 and is removed from drupal:12.0.0. Use \\Drupal\\Core\\Render\\Element\\FormElementBase::processAutocomplete() instead. See https://www.drupal.org/node/3436275', E_USER_DEPRECATED);
        return parent::processAutocomplete($element, $form_state, $complete_form);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ElementInterface::getInfo public function Returns the element properties for this element. 61
FormElement::preRenderAjaxForm public static function Adds Ajax information about an element to communicate with JavaScript. Overrides RenderElementBase::preRenderAjaxForm
FormElement::preRenderGroup public static function Adds members of this group as actual elements for rendering. Overrides RenderElementBase::preRenderGroup
FormElement::processAjaxForm public static function Form element processing handler for the #ajax form property. Overrides RenderElementBase::processAjaxForm
FormElement::processAutocomplete public static function Adds autocomplete functionality to elements. Overrides FormElementBase::processAutocomplete
FormElement::processGroup public static function Arranges elements into groups. Overrides RenderElementBase::processGroup
FormElement::processPattern public static function #process callback for #pattern form element property. Overrides FormElementBase::processPattern
FormElement::setAttributes public static function Sets a form element's class attribute. Overrides RenderElementBase::setAttributes
FormElement::validatePattern public static function #element_validate callback for #pattern form element property. Overrides FormElementBase::validatePattern
FormElement::valueCallback public static function Determines how user input is mapped to an element's #value property. Overrides FormElementBase::valueCallback
FormElement::__construct public function
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2

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