class Date in Drupal 9

Provides a form element for date selection.

Properties:

• #default_value: A string for the default date in 'Y-m-d' format.
• #size: The size of the input element in characters.

$form['expiration'] = [
  '#type' => 'date',
  '#title' => $this
    ->t('Content expiration'),
  '#default_value' => '2020-02-05',
];

Plugin annotation

@FormElement("date");

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\Date

20 string references to 'Date'

Date::getSortName in core/modules/views/src/Plugin/views/argument/Date.php

Return a description of how the argument would normally be sorted.

Datetime::processDatetime in core/lib/Drupal/Core/Datetime/Element/Datetime.php

Expands a datetime element type into date and/or time elements.

DateTimeSchemaTest::testDateTimeSchema in core/modules/datetime/tests/src/Kernel/Views/DateTimeSchemaTest.php

Tests argument plugin schema.

DbLogController::eventDetails in core/modules/dblog/src/Controller/DbLogController.php

Displays details about a specific database log message.

DbLogController::overview in core/modules/dblog/src/Controller/DbLogController.php

Displays a listing of database log messages.

... See full list

4 #type uses of Date

AjaxFormsTestAjaxElementsForm::buildForm in core/modules/system/tests/modules/ajax_forms_test/src/Form/AjaxFormsTestAjaxElementsForm.php

Form constructor.

Datetime::processDatetime in core/lib/Drupal/Core/Datetime/Element/Datetime.php

Expands a datetime element type into date and/or time elements.

FormHelperTest::providerElements in core/tests/Drupal/Tests/Core/Form/FormHelperTest.php

Provides a list of elements to test.

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

Form constructor.

File

core/lib/Drupal/Core/Render/Element/Date.php, line 25

Namespace

Drupal\Core\Render\Element

class Date extends FormElement {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = static::class;
    return [
      '#input' => TRUE,
      '#theme' => 'input__date',
      '#process' => [
        [
          $class,
          'processAjaxForm',
        ],
        [
          $class,
          'processDate',
        ],
      ],
      '#pre_render' => [
        [
          $class,
          'preRenderDate',
        ],
      ],
      '#theme_wrappers' => [
        'form_element',
      ],
      '#attributes' => [
        'type' => 'date',
      ],
      '#date_date_format' => 'Y-m-d',
    ];
  }

  /**
   * Processes a date form element.
   *
   * @param array $element
   *   The form element to process. Properties used:
   *   - #attributes: An associative array containing:
   *     - type: The type of date field rendered.
   *   - #date_date_format: The date format used in PHP formats.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   * @param array $complete_form
   *   The complete form structure.
   *
   * @return array
   *   The processed element.
   */
  public static function processDate(&$element, FormStateInterface $form_state, &$complete_form) {

    // Attach JS support for the date field, if we can determine which date
    // format should be used.
    if ($element['#attributes']['type'] == 'date' && !empty($element['#date_date_format'])) {
      $element['#attached']['library'][] = 'core/drupal.date';
      $element['#attributes']['data-drupal-date-format'] = [
        $element['#date_date_format'],
      ];
    }
    return $element;
  }

  /**
   * Adds form-specific attributes to a 'date' #type element.
   *
   * Supports HTML5 types of 'date', 'datetime', 'datetime-local', and 'time'.
   * Falls back to a plain textfield. Used as a sub-element by the datetime
   * element type.
   *
   * @param array $element
   *   An associative array containing the properties of the element.
   *   Properties used: #title, #value, #options, #description, #required,
   *   #attributes, #id, #name, #type, #min, #max, #step, #value, #size. 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 #theme 'input__date'.
   */
  public static function preRenderDate($element) {
    if (empty($element['#attributes']['type'])) {
      $element['#attributes']['type'] = 'date';
    }
    Element::setAttributes($element, [
      'id',
      'name',
      'type',
      'min',
      'max',
      'step',
      'value',
      'size',
    ]);
    static::setAttributes($element, [
      'form-' . $element['#attributes']['type'],
    ]);
    return $element;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Date::getInfo	public	function	Returns the element properties for this element. Overrides ElementInterface::getInfo
Date::preRenderDate	public static	function	Adds form-specific attributes to a 'date' #type element.
Date::processDate	public static	function	Processes a date form element.
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.
FormElement::valueCallback	public static	function	Determines how user input is mapped to an element's #value property. Overrides FormElementInterface::valueCallback	15
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
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	public	function	Determines if the plugin is configurable.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	98
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.	4
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.