class Button
Same name in other branches
- 9 core/lib/Drupal/Core/Render/Element/Button.php \Drupal\Core\Render\Element\Button
- 8.9.x core/lib/Drupal/Core/Render/Element/Button.php \Drupal\Core\Render\Element\Button
- 10 core/lib/Drupal/Core/Render/Element/Button.php \Drupal\Core\Render\Element\Button
Provides an action button form element.
When the button is pressed:
- If #submit_button is TRUE (default), the form will be submitted to Drupal, where it is validated and rebuilt. The submit handler is not invoked.
- If #submit_button is FALSE, the button will act as a regular HTML button (with the 'type' attribute set to 'button') and will not trigger a form submission. This allows developers to define custom client-side behavior using JavaScript or other mechanisms.
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.
- #submit_button: This has a default value of TRUE. If set to FALSE, the 'type' attribute is set to 'button.'
Usage Example:
$form['actions']['preview'] = [
'#type' => 'button',
'#value' => $this->t('Preview'),
];
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\Core\Render\Element\RenderElementBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Render\Element\ElementInterface
- class \Drupal\Core\Render\Element\FormElementBase extends \Drupal\Core\Render\Element\RenderElementBase implements \Drupal\Core\Render\Element\FormElementInterface
- class \Drupal\Core\Render\Element\Button extends \Drupal\Core\Render\Element\FormElementBase
- class \Drupal\Core\Render\Element\FormElementBase extends \Drupal\Core\Render\Element\RenderElementBase implements \Drupal\Core\Render\Element\FormElementInterface
- class \Drupal\Core\Render\Element\RenderElementBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Render\Element\ElementInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of Button
See also
\Drupal\Core\Render\Element\Submit
56 string references to 'Button'
- AjaxTestForm::buildForm in core/
modules/ system/ tests/ modules/ ajax_test/ src/ Form/ AjaxTestForm.php - Form constructor.
- 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.
- 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().
File
-
core/
lib/ Drupal/ Core/ Render/ Element/ Button.php, line 39
Namespace
Drupal\Core\Render\ElementView source
class Button extends FormElementBase {
/**
* {@inheritdoc}
*/
public function getInfo() {
return [
'#input' => TRUE,
'#name' => 'op',
'#is_button' => TRUE,
'#submit_button' => TRUE,
'#executes_submit_callback' => FALSE,
'#limit_validation_errors' => FALSE,
'#process' => [
[
static::class,
'processButton',
],
[
static::class,
'processAjaxForm',
],
],
'#pre_render' => [
[
static::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, #submit_button,
* #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) {
if ($element['#submit_button']) {
$element['#attributes']['type'] = 'submit';
}
else {
$element['#attributes']['type'] = 'button';
}
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 Sort descending | 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. | ||
FormElementBase::processAutocomplete | public static | function | Adds autocomplete functionality to elements. | 1 | |
FormElementBase::processPattern | public static | function | #process callback for #pattern form element property. | 1 | |
FormElementBase::validatePattern | public static | function | #element_validate callback for #pattern form element property. | 1 | |
FormElementBase::valueCallback | public static | function | Determines how user input is mapped to an element's #value property. | Overrides FormElementInterface::valueCallback | 17 |
PluginInspectionInterface::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | 7 | |
PluginInspectionInterface::getPluginId | public | function | Gets the plugin ID of the plugin instance. | 3 | |
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::setAttributes | public static | function | Sets a form element's class attribute. | Overrides ElementInterface::setAttributes | 2 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.