InputfieldDatetime class

Inputfield that accepts date and optionally time

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the InputfieldDatetime class also inherits all the methods and properties of: Inputfield, WireData and Wire.

Common

Name	Return	Summary
InputfieldDatetime::dateInputFormat	`string`	Date input format to use, see WireDateTime::$dateFormats (default='Y-m-d')
InputfieldDatetime::dateMax	`string`	Refers to the max attribute on date inputs, ISO-8601 (YYYY-MM-DD)
InputfieldDatetime::dateMin	`string`	Refers to the min attribute on date inputs, ISO-8601 (YYYY-MM-DD)
InputfieldDatetime::dateSelectFormat	`string`	Format to use for date select
InputfieldDatetime::dateStep	`int`	Refers to the step attribute on date inputs
InputfieldDatetime::datepicker	`int`	jQuery UI datepicker type (see `datepicker*` constants)
InputfieldDatetime::defaultToday	`int` `bool`	When no value is present, default to today’s date/time?
InputfieldDatetime::getConfigInputfields() InputfieldDatetime::getConfigInputfields() InputfieldDatetime::getConfigInputfields()	`InputfieldWrapper`	Date/time Inputfield configuration, per field
InputfieldDatetime::getInputType() InputfieldDatetime::getInputType() InputfieldDatetime::getInputType(string $typeName = '')	`InputfieldDatetimeType`	Get current date/time input type instance
InputfieldDatetime::getInputTypes() InputfieldDatetime::getInputTypes() InputfieldDatetime::getInputTypes()	`InputfieldDatetimeType`	Get all date/time input types
InputfieldDatetime::htmlType	`string`	When "html" is selection for $inputType, this should be one of: "date", "time" or "datetime".
InputfieldDatetime::inputType	`string`	Input type to use, one of: "text", "select" or "html" (when html type is used, also specify $htmlType).
InputfieldDatetime::placeholder	`string`	Placeholder attribute text
InputfieldDatetime::processInput() InputfieldDatetime::processInput(WireInputData $input) InputfieldDatetime::processInput(WireInputData $input)	`Inputfield` `InputfieldDatetime`	Process input
InputfieldDatetime::render() InputfieldDatetime::render() InputfieldDatetime::render()	`string`	Render the date/time inputfield
InputfieldDatetime::renderReady() InputfieldDatetime::renderReady() InputfieldDatetime::renderReady(Inputfield $parent = null, bool $renderValueMode = false)	`bool`	Called before the render method, from a hook in the Inputfield class
InputfieldDatetime::renderValue() InputfieldDatetime::renderValue() InputfieldDatetime::renderValue()	`string`	Render value for presentation, non-input
InputfieldDatetime::requiredAttr	`bool` `int`	When combined with "required" option, this also makes it use the HTML5 "required" attribute (default=false).
InputfieldDatetime::set() InputfieldDatetime::set(string $key, mixed $value) InputfieldDatetime::set(string $key, mixed $value)	`Inputfield` `WireData`	Set property
InputfieldDatetime::setAttribute() InputfieldDatetime::setAttribute(string $key, mixed $value) InputfieldDatetime::setAttribute(string $key, mixed $value)	`Inputfield` `InputfieldDatetime`	Capture setting of the 'value' attribute and convert string dates to unix timestamp
InputfieldDatetime::subDay	`int`	Substitute day when month+year or time only selectinos are made (default=8)
InputfieldDatetime::subHour	`int`	Substitute hour when date-only selections are made (default=0)
InputfieldDatetime::subMinute	`int`	Substitute minute when date-only selection are made (default=0)
InputfieldDatetime::subMonth	`int`	Substitute month when time-only selections are made (default=4)
InputfieldDatetime::subYear	`int`	Substitute year when month+day or time only selections are made (default=2010)
InputfieldDatetime::timeInputFormat	`string`	Time input format to use, see WireDateTime::$timeFormats (default='')
InputfieldDatetime::timeInputSelect	`int`	jQuery UI timeSelect type (requires datepicker)—specify 1 to use a `<select>` for time input, or 0 to use a slider (default=0)
InputfieldDatetime::timeMax	`string`	Refers to the max attribute on time inputs (HH:MM)
InputfieldDatetime::timeMin	`string`	Refers to the min attribute on time inputs (HH:MM)
InputfieldDatetime::timeSelectFormat	`string`	Format to use for time select
InputfieldDatetime::timeStep	`int`	Refers to the step attribute on time inputs
InputfieldDatetime::value	`int`	This Inputfield keeps the value in UNIX timestamp format (int).
InputfieldDatetime::yearFrom	`int`	First selectable year (default=current year - 100)
InputfieldDatetime::yearLock	`bool` `int`	Disallow selection of years outside the yearFrom/yearTo range? (default=false)
InputfieldDatetime::yearRange	`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.
InputfieldDatetime::yearTo	`int`	Last selectable year (default=current year + 20)

Additional methods and properties

In addition to the methods and properties above, InputfieldDatetime also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.236

Inputfield that accepts date and optionally time

Common

Additional methods and properties

Newest forum posts

Latest news

Subscribe to weekly ProcessWire news