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

Twitter updates

  • New post: Quietly and without interruption this week, the ProcessWire.com website (and all subdomains) moved from a single static server to a load-balanced multi-server environment, giving us even more horsepower and redundancy than before— More
    19 April 2019
  • New post: With ProcessWire 3.0.130, this week we’ll take a detailed look at a few useful new API additions made in the last few weeks, along with examples of each—More
    12 April 2019
  • New post: This week ProcessWire ProMailer has been released, plus we’ve got a nice upgrade in our community support forum, and more— More
    15 March 2019

Latest news

  • ProcessWire Weekly #258
    In the 258th issue of ProcessWire Weekly we'll cover a hosting upgrade for the processwire.com site and it's subdomains, introduce PW Review and Terminal module, and feature the new site of O'Neil Cinema. Read on!
    Weekly.pw / 20 April 2019
  • ProcessWire.com website hosting upgrades
    Quietly and without interruption this week, our whole website moved from a single static server to a load-balanced multi-server environment, giving us even more horsepower and redundancy than before.
    Blog / 19 April 2019
  • Subscribe to weekly ProcessWire news

“To Drupal, or to ProcessWire? The million dollar choice. We decided to make an early switch to PW. And in retrospect, ProcessWire was probably the best decision we made. Thanks are due to ProcessWire and the amazing system and set of modules that are in place.” —Unni Krishnan, Founder of PigtailPundits