class 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

• class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
    • class \Drupal\Core\Render\Element\RenderElement extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Render\Element\ElementInterface
      • class \Drupal\Core\Render\Element\FormElement extends \Drupal\Core\Render\Element\RenderElement implements \Drupal\Core\Render\Element\FormElementInterface
        • class \Drupal\Core\Render\Element\Button extends \Drupal\Core\Render\Element\FormElement
          • class \Drupal\Core\Render\Element\Submit extends \Drupal\Core\Render\Element\Button

Expanded class hierarchy of Submit

See also

\Drupal\Core\Render\Element\Button

File

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

Namespace

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

}

Members