FieldtypeDatetime class

Holds date and optionally time values.

For documentation about the fields used in this class, please see: wire/core/Fieldtype.php

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

Common
For hooks

Common

Name	Return	Summary
FieldtypeDatetime::convertDateFormat() FieldtypeDatetime::convertDateFormat(string $format, string $type) FieldtypeDatetime::convertDateFormat(string $format, string $type)	`string`	Given a date() format, convert it to either 'js', 'strftime' or 'regex' format
FieldtypeDatetime::exportValue() FieldtypeDatetime::exportValue(Page $page, Field $field, int $value) FieldtypeDatetime::exportValue(Page $page, Field $field, int $value, array $options = [])	`string`	Export value
FieldtypeDatetime::formatDate() FieldtypeDatetime::formatDate(int $value, string $format) FieldtypeDatetime::formatDate(int $value, string $format)	`string`	Format a date with the given PHP date() or PHP strftime() format
FieldtypeDatetime::formatValue() FieldtypeDatetime::formatValue(Page $page, Field $field, int $value) FieldtypeDatetime::formatValue(Page $page, Field $field, int $value)	`string`	Format the value for output, according to selected format and language
FieldtypeDatetime::getCompatibleFieldtypes() FieldtypeDatetime::getCompatibleFieldtypes(Field $field) FieldtypeDatetime::getCompatibleFieldtypes(Field $field)	`Fieldtypes`	Get compatible Fieldtypes
FieldtypeDatetime::getConfigInputfields() FieldtypeDatetime::getConfigInputfields(Field $field) FieldtypeDatetime::getConfigInputfields(Field $field)	`InputfieldWrapper`	Field configuration screen
FieldtypeDatetime::getDatabaseSchema() FieldtypeDatetime::getDatabaseSchema(Field $field) FieldtypeDatetime::getDatabaseSchema(Field $field)	`array`	Return database schema used by this field
FieldtypeDatetime::getDateFormats() FieldtypeDatetime::getDateFormats() FieldtypeDatetime::getDateFormats()	`array`	Return all predefined PHP date() formats for use as dates
FieldtypeDatetime::getInputfield() FieldtypeDatetime::getInputfield(Page $page, Field $field) FieldtypeDatetime::getInputfield(Page $page, Field $field)	`InputfieldDatetime`	Return the Inputfield used for date/time (InputfieldDatetime)
FieldtypeDatetime::getMatchQuery() FieldtypeDatetime::getMatchQuery(PageFinderDatabaseQuerySelect $query, string $table, string $subfield, string $operator, $value) FieldtypeDatetime::getMatchQuery(PageFinderDatabaseQuerySelect $query, string $table, string $subfield, string $operator, $value)	`DatabaseQuerySelect`	Match a date/time value in the database, as used by PageFinder
FieldtypeDatetime::getSelectorInfo() FieldtypeDatetime::getSelectorInfo(Field $field) FieldtypeDatetime::getSelectorInfo(Field $field, array $data = [])	`array`	Get selector info
FieldtypeDatetime::getTimeFormats() FieldtypeDatetime::getTimeFormats() FieldtypeDatetime::getTimeFormats()	`array`	Return all predefined PHP date() formats for use as times
FieldtypeDatetime::isEmptyValue() FieldtypeDatetime::isEmptyValue(Field $field, mixed $value) FieldtypeDatetime::isEmptyValue(Field $field, mixed $value)	`bool`	Return whether the given value is considered empty or not
FieldtypeDatetime::sanitizeValue() FieldtypeDatetime::sanitizeValue(Page $page, Field $field, $value) FieldtypeDatetime::sanitizeValue(Page $page, Field $field, $value)	`int`	Sanitize value, per Fieldtype interface
FieldtypeDatetime::sleepValue() FieldtypeDatetime::sleepValue(Page $page, Field $field, $value) FieldtypeDatetime::sleepValue(Page $page, Field $field, $value)	`string`	Convert value from timestamp to Y-m-d H:i:s date string
FieldtypeDatetime::stringToTimestamp() FieldtypeDatetime::stringToTimestamp(string $str, string $format) FieldtypeDatetime::stringToTimestamp(string $str, string $format)	`int`	Given a date/time string and expected format, convert it to a unix timestamp
FieldtypeDatetime::wakeupValue() FieldtypeDatetime::wakeupValue(Page $page, Field $field, string $value) FieldtypeDatetime::wakeupValue(Page $page, Field $field, string $value)	`int`	Convert value from Y-m-d H:i:s string to timestamp

For hooks

These methods are only useful for hooking and should not be called directly.

Name	Return	Summary
FieldtypeDatetime::getFieldSetups() FieldtypeDatetime::getFieldSetups() FieldtypeDatetime::getFieldSetups()	`array`	Get predefined setups for newly created fields of this type

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.251