class ImageButton

Same name in other branches
  1. 8.9.x core/lib/Drupal/Core/Render/Element/ImageButton.php \Drupal\Core\Render\Element\ImageButton
  2. 10 core/lib/Drupal/Core/Render/Element/ImageButton.php \Drupal\Core\Render\Element\ImageButton
  3. 11.x core/lib/Drupal/Core/Render/Element/ImageButton.php \Drupal\Core\Render\Element\ImageButton

Provides a form element for a submit button with an image.

Plugin annotation

@FormElement("image_button");

Hierarchy

Expanded class hierarchy of ImageButton

3 #type uses of ImageButton
AjaxFormsTestImageButtonForm::buildForm in core/modules/system/tests/modules/ajax_forms_test/src/Form/AjaxFormsTestImageButtonForm.php
Form constructor.
EntityDisplayFormBase::buildFieldRow in core/modules/field_ui/src/Form/EntityDisplayFormBase.php
Builds the table row structure for a single field.
FormTestDisabledElementsForm::buildForm in core/modules/system/tests/modules/form_test/src/Form/FormTestDisabledElementsForm.php
Form constructor.

File

core/lib/Drupal/Core/Render/Element/ImageButton.php, line 13

Namespace

Drupal\Core\Render\Element
View source 
class ImageButton extends Submit {
    
    /**
     * {@inheritdoc}
     */
    public function getInfo() {
        $info = parent::getInfo();
        unset($info['name']);
        return [
            '#return_value' => TRUE,
            '#has_garbage_value' => TRUE,
            '#src' => NULL,
            '#theme_wrappers' => [
                'input__image_button',
            ],
        ] + $info;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function valueCallback(&$element, $input, FormStateInterface $form_state) {
        if ($input !== FALSE) {
            if (!empty($input)) {
                // If we're dealing with Mozilla or Opera, we're lucky. It will
                // return a proper value, and we can get on with things.
                return $element['#return_value'];
            }
            else {
                // Unfortunately, in IE we never get back a proper value for THIS
                // form element. Instead, we get back two split values: one for the
                // X and one for the Y coordinates on which the user clicked the
                // button. We'll find this element in the #post data, and search
                // in the same spot for its name, with '_x'.
                $input = $form_state->getUserInput();
                foreach (explode('[', $element['#name']) as $element_name) {
                    // chop off the ] that may exist.
                    if (substr($element_name, -1) == ']') {
                        $element_name = substr($element_name, 0, -1);
                    }
                    if (!isset($input[$element_name])) {
                        if (isset($input[$element_name . '_x'])) {
                            return $element['#return_value'];
                        }
                        return NULL;
                    }
                    $input = $input[$element_name];
                }
                return $element['#return_value'];
            }
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public static function preRenderButton($element) {
        $element['#attributes']['type'] = 'image';
        Element::setAttributes($element, [
            'id',
            'name',
            'value',
        ]);
        $element['#attributes']['src'] = \Drupal::service('file_url_generator')->generateString($element['#src']);
        if (!empty($element['#title'])) {
            $element['#attributes']['alt'] = $element['#title'];
            $element['#attributes']['title'] = $element['#title'];
        }
        $element['#attributes']['class'][] = 'image-button';
        if (!empty($element['#button_type'])) {
            $element['#attributes']['class'][] = 'image-button--' . $element['#button_type'];
        }
        $element['#attributes']['class'][] = 'js-form-submit';
        $element['#attributes']['class'][] = 'form-submit';
        if (!empty($element['#attributes']['disabled'])) {
            $element['#attributes']['class'][] = 'is-disabled';
        }
        return $element;
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
Button::processButton public static function Processes a form button element.
FormElement::processAutocomplete public static function Adds autocomplete functionality to elements.
FormElement::processPattern public static function #process callback for #pattern form element property.
FormElement::validatePattern public static function #element_validate callback for #pattern form element property.
ImageButton::getInfo public function Returns the element properties for this element. Overrides Submit::getInfo
ImageButton::preRenderButton public static function Prepares a #type 'button' render element for input.html.twig. Overrides Button::preRenderButton
ImageButton::valueCallback public static function Determines how user input is mapped to an element's #value property. Overrides FormElement::valueCallback
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
RenderElement::preRenderAjaxForm public static function Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup public static function Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm public static function Form element processing handler for the #ajax form property. 1
RenderElement::processGroup public static function Arranges elements into groups.
RenderElement::setAttributes public static function Sets a form element's class attribute. Overrides ElementInterface::setAttributes

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