EasyAdmin DateTime Field

Edit this page

This field is used to represent a value that stores a PHP DateTimeInterface value (e.g. DateTime, DateTimeImmutable, etc.)

In form pages (edit and new) it looks like this:

Default style of EasyAdmin datetime field

Basic Information

  • PHP Class: EasyCorp\Bundle\EasyAdminBundle\Field\DateTimeField
  • Doctrine DBAL Type used to store this value: datetime, datetime_immutable datetimetz or datetimetz_immutable
  • Symfony Form Type used to render the field: DateTimeType

  • Rendered as:

    1
    <input type="datetime-local"> ... </select>

Options

renderAsChoice

By default, in form pages (edit and new) the field is rendered as an HTML5 input field. This is done because modern browsers display an advanced date picker for these fields, making them easier to use.

If you prefer to display the date/time as 5 separate <select> elements to pick the day, month, year, hour and minutes separately, use this option:

1
yield DateTimeField::new('...')->renderAsChoice();

Note

Setting this option is equivalent to setting widget = choice and html5 = true options in the underlying DateType Symfony field.

renderAsNativeWidget

By default, in form pages (edit and new) the field is rendered as an HTML5 input field. This is done because modern browsers display an advanced date picker for these fields, making them easier to use.

This option allows you to programmatically enable/disable this behavior (e.g. based on the result of some expression). Setting it to false is equivalent to calling renderAsChoice():

1
yield DateTimeField::new('...')->renderAsNativeWidget(false);

Note

Setting this option is equivalent to setting widget = single_text and html5 = true options in the underlying DateType Symfony field.

renderAsText

By default, in form pages (edit and new) the field is rendered as an HTML5 input field. This is done because modern browsers display an advanced date picker for these fields, making them easier to use.

If you prefer to display the date/time as a single <input type="text"> element, use this option:

1
yield DateTimeField::new('...')->renderAsText();

Note

Setting this option is equivalent to setting widget = single_text and html5 = false options in the underlying DateType Symfony field.

setFormat

By default, in read-only pages (index and detail) date/time is displayed in the format defined by the setDateTimeFormat() CRUD option. Use this option to override that default formatting:

1
2
3
4
5
6
7
// these are the predefined formats: 'short', 'medium', 'long', 'full'
yield DateTimeField::new('...')->setFormat('long', 'none');

// predefined formats are available as constants too
use EasyCorp\Bundle\EasyAdminBundle\Field\DateTimeField;

yield DateTimeField::new('...')->setFormat(DateTimeField::FORMAT_LONG, DateTimeField::FORMAT_NONE);

In addition to predefined formats, you can configure your own format by passing a valid ICU Datetime Pattern to this function:

1
2
yield DateTimeField::new('...')->setFormat('yyyy.MM.dd G 'at' HH:mm:ss zzz');
yield DateTimeField::new('...')->setFormat('yyyyy.MMMM.dd GGG hh:mm aaa');

setTimezone

By default, in read-only pages (index and detail) dates are displayed using the timezone defined by the setTimezone() CRUD option. Use this option to override that default timezone (the argument must be any of the valid PHP timezone IDs):

1
yield DateTimeField::new('...')->setTimezone('Asia/Manila');
This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.
TOC
    Version