Form and render elements - 9.5.x - drupal

Introduction to form and render elements

Render elements are referenced in render arrays. Render arrays contain data to be rendered, along with meta-data and attributes that specify how to render the data into markup; see the Render API topic for an overview of render arrays and render elements. Form arrays are a subset of render arrays, representing HTML forms; form elements are a subset of render elements, representing HTML elements for forms. See the Form API topic for an overview of forms, form processing, and form arrays.

Each form and render element type corresponds to an element plugin class; each of them either extends \Drupal\Core\Render\Element\RenderElement (render elements) or \Drupal\Core\Render\Element\FormElement (form elements). Usage and properties are documented on the individual classes, and the two base classes list common properties shared by all render elements and the form element subset, respectively.

See also

Render API overview

Form generation

\Drupal\Core\Render\Element\RenderElement

\Drupal\Core\Render\Element\FormElement

File

core/lib/Drupal/Core/Render/theme.api.php, line 465

Element machine name Type Class Namespace Summary
status_messages RenderElement StatusMessages Drupal\Core\Render\Element Provides a messages element.
status_report RenderElement StatusReport Drupal\Core\Render\Element Creates status report page element.
status_report_page RenderElement StatusReportPage Drupal\system\Element Creates status report page element.
submit FormElement Submit Drupal\Core\Render\Element Provides a form submit button.
system_compact_link RenderElement SystemCompactLink Drupal\Core\Render\Element Provides a link to show or hide help text on administration pages.
table FormElement Table Drupal\Core\Render\Element Provides a render element for a table.
tableselect FormElement Tableselect Drupal\Core\Render\Element Provides a form element for a table with radios or checkboxes in left column.
tel FormElement Tel Drupal\Core\Render\Element Provides a form element for entering a telephone number.
textarea FormElement Textarea Drupal\Core\Render\Element Provides a form element for input of multiple-line text.
textfield FormElement Textfield Drupal\Core\Render\Element Provides a one-line text field form element.
text_format RenderElement TextFormat Drupal\filter\Element Provides a text format render element.
token FormElement Token Drupal\Core\Render\Element Stores token data in a hidden form field.
toolbar RenderElement Toolbar Drupal\toolbar\Element Provides a render element for the default Drupal toolbar.
toolbar_item RenderElement ToolbarItem Drupal\toolbar\Element Provides a toolbar item that is wrapped in markup for common styling.
url FormElement Url Drupal\Core\Render\Element Provides a form element for input of a URL.
value FormElement Value Drupal\Core\Render\Element Provides a form element for storage of internal information.
vertical_tabs FormElement VerticalTabs Drupal\Core\Render\Element Provides a render element for vertical tabs in a form.
view RenderElement View Drupal\views\Element Provides a render element to display a view.
weight FormElement Weight Drupal\Core\Render\Element Provides a form element for input of a weight.

Other projects

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