OptionsSelectWidget.php

Same filename in other branches
  1. 9 core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/OptionsSelectWidget.php
  2. 10 core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/OptionsSelectWidget.php
  3. 11.x core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/OptionsSelectWidget.php

Namespace

Drupal\Core\Field\Plugin\Field\FieldWidget

File

core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/OptionsSelectWidget.php

View source
<?php

namespace Drupal\Core\Field\Plugin\Field\FieldWidget;

use Drupal\Component\Utility\Html;
use Drupal\Core\Field\FieldItemListInterface;
use Drupal\Core\Form\FormStateInterface;

/**
 * Plugin implementation of the 'options_select' widget.
 *
 * @FieldWidget(
 *   id = "options_select",
 *   label = @Translation("Select list"),
 *   field_types = {
 *     "entity_reference",
 *     "list_integer",
 *     "list_float",
 *     "list_string"
 *   },
 *   multiple_values = TRUE
 * )
 */
class OptionsSelectWidget extends OptionsWidgetBase {
    
    /**
     * {@inheritdoc}
     */
    public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
        $element = parent::formElement($items, $delta, $element, $form, $form_state);
        $element += [
            '#type' => 'select',
            '#options' => $this->getOptions($items->getEntity()),
            '#default_value' => $this->getSelectedOptions($items),
            // Do not display a 'multiple' select box if there is only one option.
'#multiple' => $this->multiple && count($this->options) > 1,
        ];
        return $element;
    }
    
    /**
     * {@inheritdoc}
     */
    protected function sanitizeLabel(&$label) {
        // Select form inputs allow unencoded HTML entities, but no HTML tags.
        $label = Html::decodeEntities(strip_tags($label));
    }
    
    /**
     * {@inheritdoc}
     */
    protected function supportsGroups() {
        return TRUE;
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getEmptyLabel() {
        if ($this->multiple) {
            // Multiple select: add a 'none' option for non-required fields.
            if (!$this->required) {
                return t('- None -');
            }
        }
        else {
            // Single select: add a 'none' option for non-required fields,
            // and a 'select a value' option for required fields that do not come
            // with a value selected.
            if (!$this->required) {
                return t('- None -');
            }
            if (!$this->has_value) {
                return t('- Select a value -');
            }
        }
    }

}

Classes

Title Deprecated Summary
OptionsSelectWidget Plugin implementation of the 'options_select' widget.

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