class Button

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

Provides an action button form element.

When the button is pressed, the form will be submitted to Drupal, where it is validated and rebuilt. The submit handler is not invoked.

Properties:

  • #limit_validation_errors: An array of form element keys that will block form submission when validation for these elements or any child elements fails. Specify an empty array to suppress all form validation errors.
  • #value: The text to be shown on the button.

Usage Example:

$form['actions']['preview'] = array(
    '#type' => 'button',
    '#value' => $this->t('Preview'),
);

Plugin annotation

@FormElement("button");

Hierarchy

Expanded class hierarchy of Button

See also

\Drupal\Core\Render\Element\Submit

43 string references to 'Button'
BlockListBuilder::buildBlocksForm in core/modules/block/src/BlockListBuilder.php
Builds the main "Blocks" portion of the form.
Button::preRenderButton in core/lib/Drupal/Core/Render/Element/Button.php
Prepares a #type 'button' render element for input.html.twig.
ckeditor.schema.yml in core/modules/ckeditor/config/schema/ckeditor.schema.yml
core/modules/ckeditor/config/schema/ckeditor.schema.yml
ckeditor5.schema.yml in core/modules/ckeditor5/config/schema/ckeditor5.schema.yml
core/modules/ckeditor5/config/schema/ckeditor5.schema.yml
claro_views_ui_display_top_alter in core/themes/claro/claro.theme
Implements hook_views_ui_display_top_alter().

... See full list

9 #type uses of Button
AjaxTestImageEffect::buildConfigurationForm in core/modules/image/tests/modules/image_module_test/src/Plugin/ImageEffect/AjaxTestImageEffect.php
ContentModerationConfigureEntityTypesForm::buildForm in core/modules/content_moderation/src/Form/ContentModerationConfigureEntityTypesForm.php
Form constructor.
FormElementsRenderTest::testDrupalRenderFormElements in core/modules/system/tests/src/Kernel/Common/FormElementsRenderTest.php
Tests rendering form elements without using doBuildForm().
FormTestButtonClassForm::buildForm in core/modules/system/tests/modules/form_test/src/Form/FormTestButtonClassForm.php
Form constructor.
FormTestDisabledElementsForm::buildForm in core/modules/system/tests/modules/form_test/src/Form/FormTestDisabledElementsForm.php
Form constructor.

... See full list

File

core/lib/Drupal/Core/Render/Element/Button.php, line 33

Namespace

Drupal\Core\Render\Element
View source 
class Button extends FormElement {
    
    /**
     * {@inheritdoc}
     */
    public function getInfo() {
        $class = static::class;
        return [
            '#input' => TRUE,
            '#name' => 'op',
            '#is_button' => TRUE,
            '#executes_submit_callback' => FALSE,
            '#limit_validation_errors' => FALSE,
            '#process' => [
                [
                    $class,
                    'processButton',
                ],
                [
                    $class,
                    'processAjaxForm',
                ],
            ],
            '#pre_render' => [
                [
                    $class,
                    'preRenderButton',
                ],
            ],
            '#theme_wrappers' => [
                'input__submit',
            ],
        ];
    }
    
    /**
     * Processes a form button element.
     */
    public static function processButton(&$element, FormStateInterface $form_state, &$complete_form) {
        // If this is a button intentionally allowing incomplete form submission
        // (e.g., a "Previous" or "Add another item" button), then also skip
        // client-side validation.
        if (isset($element['#limit_validation_errors']) && $element['#limit_validation_errors'] !== FALSE) {
            $element['#attributes']['formnovalidate'] = 'formnovalidate';
        }
        return $element;
    }
    
    /**
     * Prepares a #type 'button' render element for input.html.twig.
     *
     * @param array $element
     *   An associative array containing the properties of the element.
     *   Properties used: #attributes, #button_type, #name, #value. The
     *   #button_type property accepts any value, though core themes have CSS that
     *   styles the following button_types appropriately: 'primary', 'danger'.
     *
     * @return array
     *   The $element with prepared variables ready for input.html.twig.
     */
    public static function preRenderButton($element) {
        $element['#attributes']['type'] = 'submit';
        Element::setAttributes($element, [
            'id',
            'name',
            'value',
        ]);
        $element['#attributes']['class'][] = 'button';
        if (!empty($element['#button_type'])) {
            $element['#attributes']['class'][] = '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::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo 1
Button::preRenderButton public static function Prepares a #type 'button' render element for input.html.twig. 1
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.
FormElement::valueCallback public static function Determines how user input is mapped to an element's #value property. Overrides FormElementInterface::valueCallback 16
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.