class Date

Same name in this branch
  1. 9 core/modules/views/src/Plugin/views/sort/Date.php \Drupal\views\Plugin\views\sort\Date
  2. 9 core/modules/views/src/Plugin/views/field/Date.php \Drupal\views\Plugin\views\field\Date
  3. 9 core/modules/views/src/Plugin/views/filter/Date.php \Drupal\views\Plugin\views\filter\Date
  4. 9 core/modules/views/src/Plugin/views/argument/Date.php \Drupal\views\Plugin\views\argument\Date
  5. 9 core/modules/datetime/src/Plugin/views/sort/Date.php \Drupal\datetime\Plugin\views\sort\Date
  6. 9 core/modules/datetime/src/Plugin/views/filter/Date.php \Drupal\datetime\Plugin\views\filter\Date
  7. 9 core/modules/datetime/src/Plugin/views/argument/Date.php \Drupal\datetime\Plugin\views\argument\Date
Same name in other branches
  1. 8.9.x core/modules/views/src/Plugin/views/sort/Date.php \Drupal\views\Plugin\views\sort\Date
  2. 8.9.x core/modules/views/src/Plugin/views/field/Date.php \Drupal\views\Plugin\views\field\Date
  3. 8.9.x core/modules/views/src/Plugin/views/filter/Date.php \Drupal\views\Plugin\views\filter\Date
  4. 8.9.x core/modules/views/src/Plugin/views/argument/Date.php \Drupal\views\Plugin\views\argument\Date
  5. 8.9.x core/modules/datetime/src/Plugin/views/sort/Date.php \Drupal\datetime\Plugin\views\sort\Date
  6. 8.9.x core/modules/datetime/src/Plugin/views/filter/Date.php \Drupal\datetime\Plugin\views\filter\Date
  7. 8.9.x core/modules/datetime/src/Plugin/views/argument/Date.php \Drupal\datetime\Plugin\views\argument\Date
  8. 8.9.x core/lib/Drupal/Core/Render/Element/Date.php \Drupal\Core\Render\Element\Date
  9. 10 core/modules/views/src/Plugin/views/sort/Date.php \Drupal\views\Plugin\views\sort\Date
  10. 10 core/modules/views/src/Plugin/views/field/Date.php \Drupal\views\Plugin\views\field\Date
  11. 10 core/modules/views/src/Plugin/views/filter/Date.php \Drupal\views\Plugin\views\filter\Date
  12. 10 core/modules/views/src/Plugin/views/argument/Date.php \Drupal\views\Plugin\views\argument\Date
  13. 10 core/modules/datetime/src/Plugin/views/sort/Date.php \Drupal\datetime\Plugin\views\sort\Date
  14. 10 core/modules/datetime/src/Plugin/views/filter/Date.php \Drupal\datetime\Plugin\views\filter\Date
  15. 10 core/modules/datetime/src/Plugin/views/argument/Date.php \Drupal\datetime\Plugin\views\argument\Date
  16. 10 core/lib/Drupal/Core/Render/Element/Date.php \Drupal\Core\Render\Element\Date
  17. 11.x core/modules/views/src/Plugin/views/sort/Date.php \Drupal\views\Plugin\views\sort\Date
  18. 11.x core/modules/views/src/Plugin/views/field/Date.php \Drupal\views\Plugin\views\field\Date
  19. 11.x core/modules/views/src/Plugin/views/filter/Date.php \Drupal\views\Plugin\views\filter\Date
  20. 11.x core/modules/views/src/Plugin/views/argument/Date.php \Drupal\views\Plugin\views\argument\Date
  21. 11.x core/modules/datetime/src/Plugin/views/sort/Date.php \Drupal\datetime\Plugin\views\sort\Date
  22. 11.x core/modules/datetime/src/Plugin/views/filter/Date.php \Drupal\datetime\Plugin\views\filter\Date
  23. 11.x core/modules/datetime/src/Plugin/views/argument/Date.php \Drupal\datetime\Plugin\views\argument\Date
  24. 11.x core/lib/Drupal/Core/Render/Element/Date.php \Drupal\Core\Render\Element\Date

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

Expanded class hierarchy of Date

1 file declares its use of Date
DateElementTest.php in core/tests/Drupal/Tests/Core/Render/Element/DateElementTest.php
168 string references to 'Date'
Callbacks::dateCallback in core/modules/system/tests/modules/ajax_forms_test/src/Callbacks.php
Ajax callback triggered by date.
CallbackTest::providerCallbackArray in core/modules/migrate/tests/src/Unit/process/CallbackTest.php
Data provider for ::testCallbackArray().
claro_preprocess_input in core/themes/claro/claro.theme
Implements template_preprocess_HOOK() for input.
CommentAccessControlHandler::checkFieldAccess in core/modules/comment/src/CommentAccessControlHandler.php
Default field access as determined by this access control handler.
CommentForm::buildEntity in core/modules/comment/src/CommentForm.php
Builds an updated entity object based upon the submitted form values.

... 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
View source
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.
     *
     * @deprecated in drupal:9.4.0 and is removed from drupal:10.0.0. There is
     *   no replacement.
     *
     * @see https://www.drupal.org/node/3258267
     */
    public static function processDate(&$element, FormStateInterface $form_state, &$complete_form) {
        @trigger_error('Drupal\\Core\\Render\\Element\\Date::processDate() is deprecated in drupal:9.4.0 and is removed from drupal:10.0.0. There is no replacement. See https://www.drupal.org/node/3258267', E_USER_DEPRECATED);
        // 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

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title 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 Deprecated public static function Processes a date form element.
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 16
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
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

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