1. 8.5.x core/lib/Drupal/Core/Render/Element/Submit.php Submit
  2. 8.0.x core/lib/Drupal/Core/Render/Element/Submit.php Submit
  3. 8.1.x core/lib/Drupal/Core/Render/Element/Submit.php Submit
  4. 8.2.x core/lib/Drupal/Core/Render/Element/Submit.php Submit
  5. 8.3.x core/lib/Drupal/Core/Render/Element/Submit.php Submit
  6. 8.4.x core/lib/Drupal/Core/Render/Element/Submit.php Submit
  7. 8.6.x core/lib/Drupal/Core/Render/Element/Submit.php 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'] = array(
  '#type' => 'submit',
  '#value' => $this
    ->t('Save'),
);

Plugin annotation

@FormElement("submit");

Hierarchy

Expanded class hierarchy of Submit

See also

\Drupal\Core\Render\Element\Button

98 string references to 'Submit'
AjaxFormBlock::buildForm in core/modules/system/tests/modules/ajax_forms_test/src/Plugin/Block/AjaxFormBlock.php
Form constructor.
AjaxFormCacheTest::testBlockForms in core/modules/system/src/Tests/Ajax/AjaxFormCacheTest.php
Tests AJAX forms in blocks.
AjaxFormsTestCommandsForm::buildForm in core/modules/system/tests/modules/ajax_forms_test/src/Form/AjaxFormsTestCommandsForm.php
.
AjaxFormsTestLazyLoadForm::buildForm in core/modules/system/tests/modules/ajax_forms_test/src/Form/AjaxFormsTestLazyLoadForm.php
Form constructor.
AjaxFormsTestValidationForm::buildForm in core/modules/system/tests/modules/ajax_forms_test/src/Form/AjaxFormsTestValidationForm.php
Form constructor.

... See full list

184 #type uses of Submit
ActionAdminManageForm::buildForm in core/modules/action/src/Form/ActionAdminManageForm.php
Form constructor.
ActionsTest::buildForm in core/tests/Drupal/KernelTests/Core/Render/Element/ActionsTest.php
Form constructor.
AdvancedSettingsForm::buildForm in core/modules/views_ui/src/Form/AdvancedSettingsForm.php
Form constructor.
AjaxCssForm::buildForm in core/modules/ckeditor/tests/modules/src/Form/AjaxCssForm.php
Form constructor.
AjaxFormBlock::buildForm in core/modules/system/tests/modules/ajax_forms_test/src/Plugin/Block/AjaxFormBlock.php
Form constructor.

... See full list

File

core/lib/Drupal/Core/Render/Element/Submit.php, line 29

Namespace

Drupal\Core\Render\Element
View source
class Submit extends Button {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    return [
      '#executes_submit_callback' => TRUE,
    ] + parent::getInfo();
  }

}

Members

Contains filters are case sensitive
Namesort descending Modifiers Type Description Overrides
Button::preRenderButton public static function Prepares a #type 'button' render element for input.html.twig.
Button::processButton public static function Processes a form button element.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function Prevents serializing any properties.
DependencySerializationTrait::__wakeup public function
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
PluginBase::$configuration protected property Configuration information passed into the plugin.
PluginBase::$pluginDefinition protected property The plugin implementation definition.
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 Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::__construct public function Constructs a Drupal\Component\Plugin\PluginBase object.
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.
RenderElement::processGroup public static function Arranges elements into groups.
RenderElement::setAttributes public static function Sets a form element's class attribute. Overrides ElementInterface::setAttributes
StringTranslationTrait::$stringTranslation protected property The string translation service.
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.
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
Submit::getInfo public function Returns the element properties for this element. Overrides Button::getInfo