class Radios in Drupal 10

Provides a form element for a set of radio buttons.

Properties:

• #options: An associative array, where the keys are the returned values for each radio button, and the values are the labels next to each radio button.

Usage example:

$form['settings']['active'] = array(
  '#type' => 'radios',
  '#title' => $this
    ->t('Poll status'),
  '#default_value' => 1,
  '#options' => array(
    0 => $this
      ->t('Closed'),
    1 => $this
      ->t('Active'),
  ),
);

Element properties may be set on single option items as follows.

$form['settings']['active'][0]['#description'] = $this
  ->t('Description for the Closed option.');

Plugin annotation

@FormElement("radios");

Hierarchy

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

See also

\Drupal\Core\Render\Element\Checkboxes

\Drupal\Core\Render\Element\Radio

\Drupal\Core\Render\Element\Select

1 file declares its use of Radios

views_ui.theme.inc in core/modules/views_ui/views_ui.theme.inc

Preprocessors and theme functions for the Views UI.

4 string references to 'Radios'

FilterPluginBase::buildExposedFiltersGroupForm in core/modules/views/src/Plugin/views/filter/FilterPluginBase.php

Build the form to let users create the group of exposed filters.

FormTestCheckboxesRadiosForm::buildForm in core/modules/system/tests/modules/form_test/src/Form/FormTestCheckboxesRadiosForm.php

Form constructor.

FormTestRadiosCheckedForm::buildForm in core/modules/system/tests/modules/form_test/src/Form/FormTestRadiosCheckedForm.php

Form constructor.

FormTestValidateRequiredForm::buildForm in core/modules/system/tests/modules/form_test/src/Form/FormTestValidateRequiredForm.php

Form constructor.

70 #type uses of Radios

AccountForm::form in core/modules/user/src/AccountForm.php

Gets the actual form array to be built.

AccountSettingsForm::buildForm in core/modules/user/src/AccountSettingsForm.php

Form constructor.

Attachment::buildOptionsForm in core/modules/views/src/Plugin/views/display/Attachment.php

Provide the default form for setting options.

BasicSettingsForm::buildForm in core/modules/views_ui/src/Form/BasicSettingsForm.php

Form constructor.

BookNavigationBlock::blockForm in core/modules/book/src/Plugin/Block/BookNavigationBlock.php

... See full list

File

core/lib/Drupal/Core/Render/Element/Radios.php, line 37

Namespace

Drupal\Core\Render\Element

class Radios extends FormElement {
  use CompositeFormElementTrait;

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = static::class;
    return [
      '#input' => TRUE,
      '#process' => [
        [
          $class,
          'processRadios',
        ],
      ],
      '#theme_wrappers' => [
        'radios',
      ],
      '#pre_render' => [
        [
          $class,
          'preRenderCompositeFormElement',
        ],
      ],
    ];
  }

  /**
   * Expands a radios element into individual radio elements.
   */
  public static function processRadios(&$element, FormStateInterface $form_state, &$complete_form) {
    if (count($element['#options']) > 0) {
      $weight = 0;
      foreach ($element['#options'] as $key => $choice) {

        // Maintain order of options as defined in #options, in case the element
        // defines custom option sub-elements, but does not define all option
        // sub-elements.
        $weight += 0.001;
        $element += [
          $key => [],
        ];

        // Generate the parents as the autogenerator does, so we will have a
        // unique id for each radio button.
        $parents_for_id = array_merge($element['#parents'], [
          $key,
        ]);
        $element[$key] += [
          '#type' => 'radio',
          '#title' => $choice,
          // The key is sanitized in Drupal\Core\Template\Attribute during output
          // from the theme function.
          '#return_value' => $key,
          // Use default or FALSE. A value of FALSE means that the radio button is
          // not 'checked'.
          '#default_value' => $element['#default_value'] ?? FALSE,
          '#attributes' => $element['#attributes'],
          '#parents' => $element['#parents'],
          '#id' => HtmlUtility::getUniqueId('edit-' . implode('-', $parents_for_id)),
          '#ajax' => $element['#ajax'] ?? NULL,
          // Errors should only be shown on the parent radios element.
          '#error_no_message' => TRUE,
          '#weight' => $weight,
        ];
      }
    }
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public static function valueCallback(&$element, $input, FormStateInterface $form_state) {
    if ($input !== FALSE) {

      // When there's user input (including NULL), return it as the value.
      // However, if NULL is submitted, FormBuilder::handleInputElement() will
      // apply the default value, and we want that validated against #options
      // unless it's empty. (An empty #default_value, such as NULL or FALSE, can
      // be used to indicate that no radio button is selected by default.)
      if (!isset($input) && !empty($element['#default_value'])) {
        $element['#needs_validation'] = TRUE;
      }
      return $input;
    }
    else {

      // For default value handling, simply return #default_value. Additionally,
      // for a NULL default value, set #has_garbage_value to prevent
      // FormBuilder::handleInputElement() converting the NULL to an empty
      // string, so that code can distinguish between nothing selected and the
      // selection of a radio button whose value is an empty string.
      $value = $element['#default_value'] ?? NULL;
      if (!isset($value)) {
        $element['#has_garbage_value'] = TRUE;
      }
      return $value;
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CompositeFormElementTrait::preRenderCompositeFormElement	public static	function	Adds form element theming to an element if its title or description is set.
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
FormElement::processAutocomplete	public static	function	Adds autocomplete functionality to elements.
FormElement::processPattern	public static	function	#process callback for #pattern form element property.
FormElement::validatePattern	public static	function	#element_validate callback for #pattern form element property.
MessengerTrait::$messenger	protected	property	The messenger.	18
MessengerTrait::messenger	public	function	Gets the messenger.	18
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.
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
PluginBase::getDerivativeId	public	function
PluginBase::getPluginDefinition	public	function		2
PluginBase::getPluginId	public	function
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	53
Radios::getInfo	public	function	Returns the element properties for this element. Overrides ElementInterface::getInfo
Radios::processRadios	public static	function	Expands a radios element into individual radio elements.
Radios::valueCallback	public static	function	Determines how user input is mapped to an element's #value property. Overrides FormElement::valueCallback
RenderElement::preRenderAjaxForm	public static	function	Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup	public static	function	Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm	public static	function	Form element processing handler for the #ajax form property.	1
RenderElement::processGroup	public static	function	Arranges elements into groups.
RenderElement::setAttributes	public static	function	Sets a form element's class attribute. Overrides ElementInterface::setAttributes
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.	1
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.