Provides a form element for a single checkbox.
Properties:
- #return_value: The value to return when the checkbox is checked.
Usage example:
$form['copy'] = array(
'#type' => 'checkbox',
'#title' => $this->t('Send me a copy'),
);
Plugin annotation
@FormElement("checkbox")
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\Checkbox
- class \Drupal\Core\Render\Element\FormElement implements FormElementInterface
- class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
See also
\Drupal\Core\Render\Element\Checkboxes
File
- core/lib/Drupal/Core/Render/Element/Checkbox.php, line 26
Namespace
Drupal\Core\Render\Element
Members
| Name | Modifiers | Type | Description |
|---|---|---|---|
| Checkbox::getInfo | public | function | Returns the element properties for this element. Overrides ElementInterface::getInfo |
| Checkbox::preRenderCheckbox | public static | function | Prepares a #type 'checkbox' render element for input.html.twig. |
| Checkbox::processCheckbox | public static | function | Sets the #checked property of a checkbox element. |
| Checkbox::valueCallback | public static | function | Determines how user input is mapped to an element's #value property. Overrides FormElement::valueCallback |
| DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. |
| DependencySerializationTrait::__sleep | public | function | |
| DependencySerializationTrait::__wakeup | public | function | |
| 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. |
| PluginBase::$configuration | protected | property | Configuration information passed into the plugin. |
| 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 | 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 |
| PluginBase::getPluginId | public | function | Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId |
| PluginBase::__construct | public | function | Constructs a Drupal\Component\Plugin\PluginBase object. |
| 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. |
| 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. |
| 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. |
| StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. |
Please login to continue.