class Radio

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/Render/Element/Radio.php \Drupal\Core\Render\Element\Radio
  2. 8.9.x core/lib/Drupal/Core/Render/Element/Radio.php \Drupal\Core\Render\Element\Radio
  3. 10 core/lib/Drupal/Core/Render/Element/Radio.php \Drupal\Core\Render\Element\Radio

Provides a form element for a single radio button.

This is an internal element that is primarily used to render the radios form element. Refer to \Drupal\Core\Render\Element\Radios for more documentation.

Attributes

#[FormElement('radio')]

Hierarchy

Expanded class hierarchy of Radio

See also

\Drupal\Core\Render\Element\Radios

\Drupal\Core\Render\Element\Checkbox

11 string references to 'Radio'
claro_preprocess_input in core/themes/claro/claro.theme
Implements template_preprocess_HOOK() for input.
ContentTranslationHandler::addTranslatabilityClue in core/modules/content_translation/src/ContentTranslationHandler.php
Adds a clue about the form element translatability.
DrupalSelenium2Driver::setValue in core/tests/Drupal/FunctionalJavascriptTests/DrupalSelenium2Driver.php
ElementTest::testOptions in core/modules/system/tests/src/Functional/Form/ElementTest.php
Tests expansion of #options for #type checkboxes and radios.
FilterEntityReferenceTest::testAddEntityReferenceFieldWithDefaultSelectionHandler in core/modules/views_ui/tests/src/FunctionalJavascript/FilterEntityReferenceTest.php
Tests end to end creation of a Content Entity Reference filter.

... See full list

8 #type uses of Radio
ArgumentPluginBase::processContainerRadios in core/modules/views/src/Plugin/views/argument/ArgumentPluginBase.php
Custom form radios process function.
FieldStorageAddForm::buildForm in core/modules/field_ui/src/Form/FieldStorageAddForm.php
Form constructor.
FormElementsRenderTest::testDrupalRenderFormElements in core/modules/system/tests/src/Kernel/Common/FormElementsRenderTest.php
Tests rendering form elements without using doBuildForm().
LanguageListBuilder::buildRow in core/modules/language/src/LanguageListBuilder.php
Builds a row for an entity in the entity listing.
Radios::processRadios in core/lib/Drupal/Core/Render/Element/Radios.php
Expands a radios element into individual radio elements.

... See full list

File

core/lib/Drupal/Core/Render/Element/Radio.php, line 17

Namespace

Drupal\Core\Render\Element
View source
class Radio extends FormElementBase {
  
  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    return [
      '#input' => TRUE,
      '#default_value' => NULL,
      '#process' => [
        [
          static::class,
          'processAjaxForm',
        ],
      ],
      '#pre_render' => [
        [
          static::class,
          'preRenderRadio',
        ],
      ],
      '#theme' => 'input__radio',
      '#theme_wrappers' => [
        'form_element',
      ],
      '#title_display' => 'after',
    ];
  }
  
  /**
   * Prepares a #type 'radio' render element for input.html.twig.
   *
   * @param array $element
   *   An associative array containing the properties of the element.
   *   Properties used: #required, #return_value, #value, #attributes, #title,
   *   #description. The #name property will be sanitized before output. This is
   *   currently done by initializing Drupal\Core\Template\Attribute with all
   *   the attributes.
   *
   * @return array
   *   The $element with prepared variables ready for input.html.twig.
   */
  public static function preRenderRadio($element) {
    $element['#attributes']['type'] = 'radio';
    Element::setAttributes($element, [
      'id',
      'name',
      '#return_value' => 'value',
    ]);
    // To avoid auto-casting during '==' we convert $element['#value'] and
    // $element['#return_value'] to strings. It will prevent wrong true-checking
    // for both cases: 0 == 'string' and 'string' == 0, this will occur because
    // all numeric array values will be integers and all submitted values will
    // be strings. Array values are never valid for radios and are skipped. To
    // account for FALSE and empty string values in the #return_value, we will
    // consider any #value that evaluates to empty to be the same as any
    // #return_value that evaluates to empty.
    if (isset($element['#return_value']) && $element['#value'] !== FALSE && !is_array($element['#value']) && (empty($element['#value']) && empty($element['#return_value']) || (string) $element['#value'] === (string) $element['#return_value'])) {
      $element['#attributes']['checked'] = 'checked';
    }
    static::setAttributes($element, [
      'form-radio',
    ]);
    return $element;
  }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
FormElementBase::processAutocomplete public static function Adds autocomplete functionality to elements. 1
FormElementBase::processPattern public static function Render API callback: Handles the #pattern form element property. 1
FormElementBase::validatePattern public static function Render API callback: Handles the #pattern form element property.. 1
FormElementBase::valueCallback public static function Determines how user input is mapped to an element's #value property. Overrides FormElementInterface::valueCallback 17
MessengerTrait::$messenger protected property The messenger. 25
MessengerTrait::messenger public function Gets the messenger. 25
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. 1
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 Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 2
PluginBase::getPluginId public function Gets the plugin ID of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable Deprecated public function Determines if the plugin is configurable.
Radio::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo
Radio::preRenderRadio public static function Prepares a #type 'radio' render element for input.html.twig.
RenderElementBase::$renderParent protected property The parent element.
RenderElementBase::$renderParentName protected property The parent key.
RenderElementBase::$storage protected property The storage.
RenderElementBase::addChild public function Adds a child render element. Overrides ElementInterface::addChild
RenderElementBase::changeType public function Change the type of the element. Overrides ElementInterface::changeType
RenderElementBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 2
RenderElementBase::createChild public function Creates a render object and attaches it to the current render object. Overrides ElementInterface::createChild
RenderElementBase::elementInfoManager protected function Returns the element info manager.
RenderElementBase::getChild public function Gets a child. Overrides ElementInterface::getChild
RenderElementBase::getChildren public function Returns child elements. Overrides ElementInterface::getChildren
RenderElementBase::initializeInternalStorage public function Initialize storage. Overrides ElementInterface::initializeInternalStorage
RenderElementBase::preRenderAjaxForm public static function Adds Ajax information about an element to communicate with JavaScript. 2
RenderElementBase::preRenderGroup public static function Adds members of this group as actual elements for rendering. 2
RenderElementBase::processAjaxForm public static function Form element processing handler for the #ajax form property. 3
RenderElementBase::processGroup public static function Arranges elements into groups. 2
RenderElementBase::removeChild public function Removes a child. Overrides ElementInterface::removeChild
RenderElementBase::setAttributes public static function Sets a form element's class attribute. Overrides ElementInterface::setAttributes 2
RenderElementBase::setType protected function Set type on initialize. 1
RenderElementBase::toRenderable public function Returns a render array. Overrides ElementInterface::toRenderable
RenderElementBase::__construct public function Constructs a new render element object. Overrides PluginBase::__construct 6
RenderElementBase::__get public function Magic method: gets a property value.
RenderElementBase::__isset public function Magic method: checks if a property value is set.
RenderElementBase::__set public function Magic method: Sets a property value.
RenderElementBase::__sleep public function Overrides DependencySerializationTrait::__sleep
RenderElementBase::__unset public function Magic method: unsets a property value.
RenderElementBase::__wakeup public function Overrides DependencySerializationTrait::__wakeup
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. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language. 1

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