FieldtypeDatetime class

Field that stores a 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 FieldtypeDatetime class also inherits all the methods and properties of: Fieldtype, WireData and Wire.

Show class?             Show args?        

Common

NameReturnSummary 
FieldtypeDatetime::convertDateFormat(string $format, string $type)
stringGiven a date() format, convert it to either 'js', 'strftime' or 'regex' format 
FieldtypeDatetime::exportValue(Page $page, Field $field, int $value)
stringExport value
FieldtypeDatetime::formatDate(int $value, string $format)
stringFormat a date with the given PHP date() or PHP strftime() format 
FieldtypeDatetime::formatValue(Page $page, Field $field, int $value)
stringFormat the value for output, according to selected format and language
FieldtypeDatetime::getCompatibleFieldtypes(Field $field)
FieldtypesGet compatible Fieldtypes
FieldtypeDatetime::getConfigInputfields(Field $field)
InputfieldWrapperField configuration screen
FieldtypeDatetime::getDatabaseSchema(Field $field)
arrayReturn database schema used by this field 
FieldtypeDatetime::getDateFormats()
arrayReturn all predefined PHP date() formats for use as dates 
FieldtypeDatetime::getInputfield(Page $page, Field $field)
InputfieldDatetimeReturn the Inputfield used for date/time (InputfieldDatetime) 
FieldtypeDatetime::getMatchQuery(PageFinderDatabaseQuerySelect $query, string $table, string $subfield, string $operator, $value)
DatabaseQuerySelectMatch a date/time value in the database, as used by PageFinder 
FieldtypeDatetime::getSelectorInfo(Field $field)
arrayGet selector info
FieldtypeDatetime::getTimeFormats()
arrayReturn all predefined PHP date() formats for use as times 
FieldtypeDatetime::isEmptyValue(Field $field, mixed $value)
boolReturn whether the given value is considered empty or not 
FieldtypeDatetime::sanitizeValue(Page $page, Field $field, $value)
intSanitize value, per Fieldtype interface 
FieldtypeDatetime::sleepValue(Page $page, Field $field, $value)
stringConvert value from timestamp to Y-m-d H:i:s date string
FieldtypeDatetime::stringToTimestamp(string $str, string $format)
intGiven a date/time string and expected format, convert it to a unix timestamp 
FieldtypeDatetime::wakeupValue(Page $page, Field $field, string $value)
intConvert value from Y-m-d H:i:s string to timestamp

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.244

Latest news

  • ProcessWire Weekly #559
    The 559th issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 25 January 2025
  • ProcessWire 3.0.244 new main/master version
    ProcessWire 3.0.244 is our newest main/master/stable version. It's been more than a year in the making and is packed with tons of new features, issue fixes, optimizations and more. This post covers all the details.
    Blog / 18 January 2025
  • Subscribe to weekly ProcessWire news

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK