class Submit

Same name and namespace in other branches

9 core/lib/Drupal/Core/Render/Element/Submit.php \Drupal\Core\Render\Element\Submit
8.9.x core/lib/Drupal/Core/Render/Element/Submit.php \Drupal\Core\Render\Element\Submit
10 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:

@property $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'] ). @property $value The text to be shown on the button.

Usage Example:

$form['actions']['submit'] = [
  '#type' => 'submit',
  '#value' => $this->t('Save'),
];

Attributes

#[FormElement('submit')]

Hierarchy

class \Drupal\Component\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
  - class \Drupal\Core\Render\Element\RenderElementBase extends \Drupal\Core\Render\Element\ElementInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface implements \Drupal\Core\Plugin\PluginBase
    - class \Drupal\Core\Render\Element\FormElementBase extends \Drupal\Core\Render\Element\FormElementInterface implements \Drupal\Core\Render\Element\RenderElementBase
      - class \Drupal\Core\Render\Element\Button implements \Drupal\Core\Render\Element\FormElementBase
        class \Drupal\Core\Render\Element\Submit implements \Drupal\Core\Render\Element\Button

Expanded class hierarchy of Submit

File

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

Namespace

Drupal\Core\Render\Element

View on git.drupalcode.org

View source

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

}

Members

Title Sort descending	Deprecated	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.
DependencySerializationTrait::$_entityStorages		protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds		protected	property	An array of service IDs keyed by property name used for serialization.
FormElementBase::processAutocomplete		public static	function	Adds autocomplete functionality to elements.		1
FormElementBase::processPattern		public static	function	Render API callback: Handles the #pattern form element property.		1
FormElementBase::validatePattern		public static	function	Render API callback: Handles the #pattern form element property..		1
FormElementBase::valueCallback		public static	function	Determines how user input is mapped to an element's #value property.	Overrides FormElementInterface::valueCallback	17
MessengerTrait::$messenger		protected	property	The messenger.		25
MessengerTrait::messenger		public	function	Gets the messenger.		25
MessengerTrait::setMessenger		public	function	Sets the messenger.
PluginBase::$configuration		protected	property	Configuration information passed into the plugin.		1
PluginBase::$pluginDefinition		protected	property	The plugin implementation definition.		1
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	2
PluginBase::getPluginId		public	function	Gets the plugin ID of the plugin instance.	Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	Deprecated	public	function	Determines if the plugin is configurable.
RenderElementBase::$renderParent		protected	property	The parent element.
RenderElementBase::$renderParentName		protected	property	The parent key.
RenderElementBase::$storage		protected	property	The storage.
RenderElementBase::addChild		public	function	Adds a child render element.	Overrides ElementInterface::addChild
RenderElementBase::changeType		public	function	Change the type of the element.	Overrides ElementInterface::changeType
RenderElementBase::create		public static	function	Creates an instance of the plugin.	Overrides ContainerFactoryPluginInterface::create	2
RenderElementBase::createChild		public	function	Creates a render object and attaches it to the current render object.	Overrides ElementInterface::createChild
RenderElementBase::elementInfoManager		protected	function	Returns the element info manager.
RenderElementBase::getChild		public	function	Gets a child.	Overrides ElementInterface::getChild
RenderElementBase::getChildren		public	function	Returns child elements.	Overrides ElementInterface::getChildren
RenderElementBase::initializeInternalStorage		public	function	Initialize storage.	Overrides ElementInterface::initializeInternalStorage
RenderElementBase::preRenderAjaxForm		public static	function	Adds Ajax information about an element to communicate with JavaScript.		2
RenderElementBase::preRenderGroup		public static	function	Adds members of this group as actual elements for rendering.		2
RenderElementBase::processAjaxForm		public static	function	Form element processing handler for the #ajax form property.		3
RenderElementBase::processGroup		public static	function	Arranges elements into groups.		2
RenderElementBase::removeChild		public	function	Removes a child.	Overrides ElementInterface::removeChild
RenderElementBase::setAttributes		public static	function	Sets a form element's class attribute.	Overrides ElementInterface::setAttributes	2
RenderElementBase::setType		protected	function	Set type on initialize.		1
RenderElementBase::toRenderable		public	function	Returns a render array.	Overrides ElementInterface::toRenderable
RenderElementBase::__construct		public	function	Constructs a new render element object.	Overrides PluginBase::__construct	6
RenderElementBase::__get		public	function	Magic method: gets a property value.
RenderElementBase::__isset		public	function	Magic method: checks if a property value is set.
RenderElementBase::__set		public	function	Magic method: Sets a property value.
RenderElementBase::__sleep		public	function		Overrides DependencySerializationTrait::__sleep
RenderElementBase::__unset		public	function	Magic method: unsets a property value.
RenderElementBase::__wakeup		public	function		Overrides DependencySerializationTrait::__wakeup
StringTranslationTrait::$stringTranslation		protected	property	The string translation service.		3
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.		2
StringTranslationTrait::t		protected	function	Translates a string to the current language or to a given language.		1
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.

class Submit

Attributes

Hierarchy

See also

File

Namespace

Members

Search drupal 11.x

API Navigation

Breadcrumb

class Submit

Attributes

Hierarchy

See also

File

Namespace

Members

Search drupal 11.x

API Navigation