InputfieldDatetime class
Inputfield that accepts date and optionally time
// get a datetime Inputfield
$f = $modules->get('InputfieldDatetime');
$f->attr('name', 'test_date');
$f->label = 'Test date';
$f->val(time()); // value is get or set a UNIX timestamp
// date input with jQuery UI datepicker on focus
$f->inputType = 'text'; // not necessary as this is the default
$f->datepicker = InputfieldDatetime::datepickerFocus;
// date selects
$f->inputType = 'select';
$f->dateSelectFormat = 'mdy'; // month abbr (i.e. 'Sep'), day, year
$f->dateSelectFormat = 'Mdy'; // month full (i.e. 'September'), day, year
$f->yearFrom = 2019; // optional year range from
$f->yearTo = 2024; // optional year range to
// HTML5 date, time or date+time inputs
$f->inputType = 'html';
$f->htmlType = 'date'; // or 'time' or 'datetime'
Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the Inputfield
class also inherits all the methods and properties of: Inputfield, WireData and Wire.
Common
Properties
Name | Return | Summary | Default |
---|---|---|---|
Inputfield | bool int | Show a select dropdown to allow changing month? | true |
Inputfield | bool int | Show a select dropdown to allow changing year? | true |
Inputfield | string | Date input format to use, see WireDateTime::$dateFormats | 'Y-m-d' |
Inputfield | string | Refers to the max attribute on date inputs, ISO-8601 (YYYY-MM-DD) | |
Inputfield | string | Refers to the min attribute on date inputs, ISO-8601 (YYYY-MM-DD) | |
Inputfield | string | Format to use for date select, i.e. 'mdy' for 'Sep 1 2024' or 'Mdy' for 'September 1 2024' | |
Inputfield | int | Refers to the step attribute on date inputs | |
Inputfield | int | jQuery UI datepicker type (see `datepicker*` constants) | |
Inputfield | int bool | When no value is present, default to today’s date/time? | |
Inputfield | string | When "html" is selection for $inputType, this should be one of: "date", "time" or "datetime". | |
Inputfield | string | Input type to use, one of: "text", "select" or "html" (when html type is used, also specify $htmlType). | |
Inputfield | int | Number of month calendars to show together side-by-side | 1 |
Inputfield | string | Placeholder attribute text | |
Inputfield | bool int | When combined with "required" option, this also makes it use the HTML5 "required" attribute . | false |
Inputfield | string | Animation type | 'fade' |
Inputfield | bool int | Show "Today" and "Done" buttons under the calendar? | false |
Inputfield | bool int | Show the month after the year? | false |
Inputfield | bool int | Show dates in other months (non-selectable) at the start or end of the current month? | false |
Inputfield | int | Substitute day when month+year or time only selectinos are made | 8 |
Inputfield | int | Substitute hour when date-only selections are made | 0 |
Inputfield | int | Substitute minute when date-only selection are made | 0 |
Inputfield | int | Substitute month when time-only selections are made | 4 |
Inputfield | int | Substitute year when month+day or time only selections are made | 2010 |
Inputfield | string | Time input format to use, see WireDateTime::$timeFormats | '' |
Inputfield | int | jQuery UI timeSelect type (requires datepicker)—specify 1 to use a `<select>` for time input, or 0 to use a slider | 0 |
Inputfield | string | Refers to the max attribute on time inputs (HH:MM) | |
Inputfield | string | Refers to the min attribute on time inputs (HH:MM) | |
Inputfield | string | Format to use for time select | |
Inputfield | int | Refers to the step attribute on time inputs | |
Inputfield | int | This Inputfield keeps the value in UNIX timestamp format (int). | |
Inputfield | int | First selectable year | current year - 100 |
Inputfield | bool int | Disallow selection of years outside the yearFrom/yearTo range? | false |
Inputfield | string | Selectable year range in the format `-30:+20` where -30 is number of years before now and +20 is number of years after now. | |
Inputfield | int | Last selectable year | current year + 20 |
Additional methods and properties
In addition to the methods and properties above, Inputfield
API reference based on ProcessWire core version 3.0.251