Table

Provides a render element for a table.

Note: Although this extends FormElement, it can be used outside the context of a form.

Properties:

• #header: An array of table header labels.
• #rows: An array of the rows to be displayed. Each row is either an array of cell contents or an array of properties as described in table.html.twig Alternatively specify the data for the table as child elements of the table element. Table elements would contain rows elements that would in turn contain column elements.
• #empty: Text to display when no rows are present.
• #responsive: Indicates whether to add the drupal.responsive_table library providing responsive tables. Defaults to TRUE.
• #sticky: Indicates whether to add the drupal.tableheader library that makes table headers always visible at the top of the page. Defaults to FALSE.

Usage example:

$form['contacts'] = array(
  '#type' => 'table',
  '#caption' => $this->t('Sample Table'),
  '#header' => array($this->t('Name'), $this->t('Phone')),
);

for ($i = 1; $i <= 4; $i++) {
  $form['contacts'][$i]['#attributes'] = array('class' => array('foo', 'baz'));
  $form['contacts'][$i]['name'] = array(
    '#type' => 'textfield',
    '#title' => $this->t('Name'),
    '#title_display' => 'invisible',
  );

  $form['contacts'][$i]['phone'] = array(
    '#type' => 'tel',
    '#title' => $this->t('Phone'),
    '#title_display' => 'invisible',
  );
}

$form['contacts'][]['colspan_example'] = array(
  '#plain_text' => 'Colspan Example',
  '#wrapper_attributes' => array('colspan' => 2, 'class' => array('foo', 'bar')),
);

Plugin annotation

@FormElement("table")

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
    • class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
      • class \Drupal\Core\Render\Element\FormElement implements FormElementInterface
        • class \Drupal\Core\Render\Element\Table

See also

\Drupal\Core\Render\Element\Tableselect

File

core/lib/Drupal/Core/Render/Element/Table.php, line 60

Namespace

Drupal\Core\Render\Element

Members