Fieldtype class

Fieldtype is a module type used to represent a type of field. All Fieldtype modules descend from this.

Almost all methods in a Fieldtype are primarily of concern to module developers, as Fieldtype modules do not have a public API (most of the time). Instead, they provide methods used by Page and Field objects (and related) to work with the field data. Most Fieldtype modules only need to implement a few methods like Fieldtype::sanitizeValue() (which is required) and Fieldtype::getDatabaseSchema(), as the default implementation of most other methods provided in this Fieldtype class accounts for most situations already.


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

Show class?             Show args?        

Loading

NameReturnSummary 
Fieldtype::getBlankValue($page, Field $field)
string int object nullReturn the blank value for this fieldtype, whether that is a blank string, zero value, blank object or array 
Fieldtype::getLoadQuery(Field $field, DatabaseQuerySelect $query)
DatabaseQuerySelectReturn the query used for loading all parts of the data from this field. 
Fieldtype::getLoadQueryAutojoin(Field $field, DatabaseQuerySelect $query)
DatabaseQuerySelect nullReturn the query used for Autojoining this field (if different from getLoadQuery) or NULL if autojoin not allowed. 
Fieldtype::loadPageField(Page $page, Field $field)
mixed nullLoad the given page field from the database table and return the value.
Fieldtype::loadPageFieldFilter(Page $page, Field $field, $selector)
mixed nullLoad the given page field from the database table and return a *filtered* value.
Fieldtype::sanitizeValue(Page $page, Field $field, $value)
string int WireArray objectSanitize the value for runtime storage and return it. 
Fieldtype::wakeupValue(Page $page, Field $field, $value)
string int array objectGiven a raw value (value as stored in database), return the value as it would appear in a Page object.

Other

NameReturnSummary 
Fieldtype::cloneField(Field $field)
FieldReturn a cloned copy of $field
Fieldtype::get(string $key)
mixedGet a property from this Fieldtype’s data 
Fieldtype::getInputfield(Page $page, Field $field)
Inputfield nullReturn new instance of the Inputfield module associated with this Fieldtype. 
Fieldtype::install()
(nothing)Install this Fieldtype, consistent with optional Module interface
Fieldtype::longName string Long name of Fieldtype, which is typically the module title.  
Fieldtype::name string Name of Fieldtype module.  
Fieldtype::shortName string Short name of Fieldtype, which excludes the "Fieldtype" prefix.  
Fieldtype::uninstall()
(nothing)Uninstall this Fieldtype, consistent with optional Module interface
Fieldtype::upgrade($fromVersion, $toVersion)
(nothing)Called when module version changes

Common

NameReturnSummary 
Fieldtype::importValue(Page $page, Field $field, $value)
string float int array object)
Fieldtype::renamedField(Field $field, $prevName)
(nothing)

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.137

Twitter updates

  • We added WebP image support this year and many have been adopting it in existing projects. We look at a process used for migrating existing websites to WebP images— from preliminary considerations to implementation & testing, w/lots of tips & tricks too: More
    16 August 2019
  • Core version 3.0.137 on the dev branch adds the ability to hook multiple methods at once, in a single call. This post details how it works and provides a useful example of how you might put it to use in your development environment— More
    2 August 2019
  • ProcessWire 3.0.136 updates our CKEditor version and adds a new backtrace() method to the core Debug class— More
    26 July 2019

Latest news

  • ProcessWire Weekly #275
    In the 275th issue of ProcessWire Weekly we're going to walk you through the new features included in ProcessWire 3.0.138, cover some WebP related stuff, and highlight recent forum posts and online resources. Read on!
    Weekly.pw / 17 August 2019
  • WebP images on an existing site
    In this post we’ll look at a process used for migrating an existing website to use WebP images. We’ll cover everything from preliminary considerations to implementation and testing, with lots of tips and tricks along the way.
    Blog / 16 August 2019
  • Subscribe to weekly ProcessWire news

I just love the easy and intuitive ProcessWire API. ProcessWire rocks!” —Jens Martsch, Web developer