Tableselect

Provides a form element for a table with radios or checkboxes in left column.

Properties:

• #header: An array of table header labels.
• #options: An associative array where each key is the value returned when a user selects the radio button or checkbox, and each value is the row of table data.
• #empty: The message to display if table does not have any options.
• #multiple: Set to FALSE to render the table with radios instead checkboxes.
• #js_select: Set to FALSE if you don't want the select all checkbox added to the header.

Other properties of the \Drupal\Core\Render\Element\Table element are also available.

Usage example:

$header = [
  'first_name' => $this->t('First Name'),
  'last_name' => $this->t('Last Name'),
];

$options = [
  1 => ['first_name' => 'Indy', 'last_name' => 'Jones'],
  2 => ['first_name' => 'Darth', 'last_name' => 'Vader'],
  3 => ['first_name' => 'Super', 'last_name' => 'Man'],
];

$form['table'] = array(
  '#type' => 'tableselect',
  '#header' => $header,
  '#options' => $options,
  '#empty' => $this->t('No users found'),
);

See https://www.drupal.org/node/945102 for a full explanation.

Plugin annotation

@FormElement("tableselect")

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
          • class \Drupal\Core\Render\Element\Tableselect

See also

\Drupal\Core\Render\Element\Table

File

core/lib/Drupal/Core/Render/Element/Tableselect.php, line 53

Namespace

Drupal\Core\Render\Element

Members