class Submit

Same name in other branches
  1. 8.9.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. 11.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
Form constructor.
AjaxFormBlock::buildForm in core/modules/system/tests/modules/ajax_forms_test/src/Plugin/Block/AjaxFormBlock.php
Form constructor.
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.
AjaxFormsTestSimpleForm::buildForm in core/modules/system/tests/modules/ajax_forms_test/src/Form/AjaxFormsTestSimpleForm.php
Form constructor.

... See full list

204 #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.
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
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

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.
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
Submit::getInfo public function Returns the element properties for this element. Overrides Button::getInfo 1

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