class Submit
Same name and namespace in other branches
- 11.x core/lib/Drupal/Core/Render/Element/Submit.php \Drupal\Core\Render\Element\Submit
- 9 core/lib/Drupal/Core/Render/Element/Submit.php \Drupal\Core\Render\Element\Submit
- 8.9.x core/lib/Drupal/Core/Render/Element/Submit.php \Drupal\Core\Render\Element\Submit
Provides a form submit button.
Submit buttons are processed the same as regular buttons, except they trigger the form's submit handler.
Properties:
- #submit: Specifies an alternate callback for form submission when the submit button is pressed. Use '::methodName' format or an array containing the object and method name (for example, [ $this, 'methodName'] ).
- #value: The text to be shown on the button.
Usage Example:
$form['actions']['submit'] = [
'#type' => 'submit',
'#value' => $this->t('Save'),
];
Attributes
#[FormElement('submit')]
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
- class \Drupal\Core\Render\Element\RenderElementBase implements \Drupal\Core\Render\Element\ElementInterface extends \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Render\Element\FormElementBase implements \Drupal\Core\Render\Element\FormElementInterface extends \Drupal\Core\Render\Element\RenderElementBase
- class \Drupal\Core\Render\Element\Button extends \Drupal\Core\Render\Element\FormElementBase
- class \Drupal\Core\Render\Element\Submit extends \Drupal\Core\Render\Element\Button
- class \Drupal\Core\Render\Element\Button extends \Drupal\Core\Render\Element\FormElementBase
- class \Drupal\Core\Render\Element\FormElementBase implements \Drupal\Core\Render\Element\FormElementInterface extends \Drupal\Core\Render\Element\RenderElementBase
- class \Drupal\Core\Render\Element\RenderElementBase implements \Drupal\Core\Render\Element\ElementInterface extends \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of Submit
See also
\Drupal\Core\Render\Element\Button
36 string references to 'Submit'
- Button::preRenderButton in core/
lib/ Drupal/ Core/ Render/ Element/ Button.php - Prepares a #type 'button' render element for input.html.twig.
- claro_views_ui_display_top_alter in core/
themes/ claro/ claro.theme - Implements hook_views_ui_display_top_alter().
- content_translation_test_form_node_form_alter in core/
modules/ content_translation/ tests/ modules/ content_translation_test/ content_translation_test.module - Implements hook_form_BASE_FORM_ID_alter().
- FileTestForm::buildForm in core/
modules/ file/ tests/ file_test/ src/ Form/ FileTestForm.php - FileTestSaveUploadFromForm::buildForm in core/
modules/ file/ tests/ file_test/ src/ Form/ FileTestSaveUploadFromForm.php
45 #type uses of Submit
- ActionAdminManageForm::buildForm in core/
modules/ action/ src/ Form/ ActionAdminManageForm.php - BookAdminEditForm::buildForm in core/
modules/ book/ src/ Form/ BookAdminEditForm.php - book_form_node_form_alter in core/
modules/ book/ book.module - Implements hook_form_BASE_FORM_ID_alter() for \Drupal\node\NodeForm.
- ConfigFormBase::buildForm in core/
lib/ Drupal/ Core/ Form/ ConfigFormBase.php - ConfirmFormBase::buildForm in core/
lib/ Drupal/ Core/ Form/ ConfirmFormBase.php
File
-
core/
lib/ Drupal/ Core/ Render/ Element/ Submit.php, line 29
Namespace
Drupal\Core\Render\ElementView source
class Submit extends Button {
/**
* {@inheritdoc}
*/
public function getInfo() {
return [
'#executes_submit_callback' => TRUE,
] + parent::getInfo();
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
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. | ||
DependencySerializationTrait::$_entityStorages | protected | property | An array of entity type IDs keyed by the property name of their storages. | ||
DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. | ||
DependencySerializationTrait::__sleep | public | function | 2 | ||
DependencySerializationTrait::__wakeup | public | function | #[\ReturnTypeWillChange] | 2 | |
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 | Overrides FormElementInterface::valueCallback | 17 | |
MessengerTrait::$messenger | protected | property | The messenger. | 25 | |
MessengerTrait::messenger | public | function | Gets the messenger. | 25 | |
MessengerTrait::setMessenger | public | function | Sets the messenger. | ||
PluginBase::$configuration | protected | property | Configuration information passed into the plugin. | 1 | |
PluginBase::$pluginDefinition | protected | property | The plugin implementation definition. | 1 | |
PluginBase::$pluginId | protected | property | The plugin ID. | ||
PluginBase::DERIVATIVE_SEPARATOR | constant | A string which is used to separate base plugin IDs from the derivative ID. | |||
PluginBase::getBaseId | public | function | Overrides DerivativeInspectionInterface::getBaseId | ||
PluginBase::getDerivativeId | public | function | Overrides DerivativeInspectionInterface::getDerivativeId | ||
PluginBase::getPluginDefinition | public | function | Overrides PluginInspectionInterface::getPluginDefinition | 2 | |
PluginBase::getPluginId | public | function | Overrides PluginInspectionInterface::getPluginId | ||
PluginBase::isConfigurable | public | function | Determines if the plugin is configurable. | ||
PluginBase::__construct | public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | 86 | |
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 | Overrides ElementInterface::setAttributes | 2 | |
StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 3 | |
StringTranslationTrait::formatPlural | protected | function | Formats a string containing a count of items. | ||
StringTranslationTrait::getNumberOfPlurals | protected | function | Returns the number of plurals supported by a given language. | ||
StringTranslationTrait::getStringTranslation | protected | function | Gets the string translation service. | ||
StringTranslationTrait::setStringTranslation | public | function | Sets the string translation service to use. | 2 | |
StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. | ||
Submit::getInfo | public | function | Overrides Button::getInfo | 1 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.