Submit.php

Same filename and directory in other branches
  1. 9 core/lib/Drupal/Core/Render/Element/Submit.php
  2. 8.9.x core/lib/Drupal/Core/Render/Element/Submit.php
  3. 10 core/lib/Drupal/Core/Render/Element/Submit.php

Namespace

Drupal\Core\Render\Element

File

core/lib/Drupal/Core/Render/Element/Submit.php

View source
<?php

namespace Drupal\Core\Render\Element;

use Drupal\Core\Render\Attribute\FormElement;

/**
 * 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:
 * @code
 * $form['actions']['submit'] = [
 *   '#type' => 'submit',
 *   '#value' => $this->t('Save'),
 * ];
 * @endcode
 *
 * @see \Drupal\Core\Render\Element\Button
 */
class Submit extends Button {
    
    /**
     * {@inheritdoc}
     */
    public function getInfo() {
        return [
            '#executes_submit_callback' => TRUE,
        ] + parent::getInfo();
    }

}

Classes

Title Deprecated Summary
Submit Provides a form submit button.

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