class Submit

Same name and namespace in other branches
  1. 11.x core/lib/Drupal/Core/Render/Element/Submit.php \Drupal\Core\Render\Element\Submit
  2. 10 core/lib/Drupal/Core/Render/Element/Submit.php \Drupal\Core\Render\Element\Submit
  3. 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'] = array(
  '#type' => 'submit',
  '#value' => $this->t('Save'),
);

Plugin annotation

@FormElement("submit");

Hierarchy

Expanded class hierarchy of Submit

See also

\Drupal\Core\Render\Element\Button

143 string references to 'Submit'
ActionsTest::buildForm in core/tests/Drupal/KernelTests/Core/Render/Element/ActionsTest.php
AjaxFormBlock::buildForm in core/modules/system/tests/modules/ajax_forms_test/src/Plugin/Block/AjaxFormBlock.php
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
AjaxFormsTestSimpleForm::buildForm in core/modules/system/tests/modules/ajax_forms_test/src/Form/AjaxFormsTestSimpleForm.php

... See full list

204 #type uses of Submit
ActionAdminManageForm::buildForm in core/modules/action/src/Form/ActionAdminManageForm.php
ActionsTest::buildForm in core/tests/Drupal/KernelTests/Core/Render/Element/ActionsTest.php
AddFormBase::buildActions in core/modules/media_library/src/Form/AddFormBase.php
Returns an array of supported actions for the form.
AddFormBase::buildEntityFormElement in core/modules/media_library/src/Form/AddFormBase.php
Builds the sub-form for setting required fields on a new media item.
AdvancedSettingsForm::buildForm in core/modules/views_ui/src/Form/AdvancedSettingsForm.php

... 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();
  }

}

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