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

Latest news

  • ProcessWire Weekly #547
    In the 547th issue of ProcessWire Weekly we're going to check out the latest core updates, introduce a couple of new modules, and more. Read on!
    Weekly.pw / 2 November 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

“We chose ProcessWire because of its excellent architecture, modular extensibility and the internal API. The CMS offers the necessary flexibility and performance for such a complex website like superbude.de. ProcessWire offers options that are only available for larger systems, such as Drupal, and allows a much slimmer development process.” —xport communication GmbH