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 
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 
getLoadQuery(Field $field, DatabaseQuerySelect $query)
DatabaseQuerySelectReturn the query used for loading all parts of the data from this field. 
getLoadQueryAutojoin(Field $field, DatabaseQuerySelect $query)
DatabaseQuerySelect nullReturn the query used for Autojoining this field (if different from getLoadQuery) or NULL if autojoin not allowed. 
loadPageField(Page $page, Field $field)
mixed nullLoad the given page field from the database table and return the value.
loadPageFieldFilter(Page $page, Field $field, $selector)
mixed nullLoad the given page field from the database table and return a *filtered* value.
sanitizeValue(Page $page, Field $field, $value)
string int WireArray objectSanitize the value for runtime storage and return it. 
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 
cloneField(Field $field)
FieldReturn a cloned copy of $field
get(string $key)
mixedGet a property from this Fieldtype’s data 
getInputfield(Page $page, Field $field)
Inputfield nullReturn new instance of the Inputfield module associated with this Fieldtype. 
install()
(nothing)Install this Fieldtype, consistent with optional Module interface
longName string Long name of Fieldtype, which is typically the module title.  
name string Name of Fieldtype module.  
shortName string Short name of Fieldtype, which excludes the "Fieldtype" prefix.  
uninstall()
(nothing)Uninstall this Fieldtype, consistent with optional Module interface
upgrade($fromVersion, $toVersion)
(nothing)Called when module version changes

Common

NameReturnSummary 
getFieldClass()
stringGet class name to use Field objects of this type (must be class that extends Field class) 
getFieldSetups()
array
importValue(Page $page, Field $field, $value)
string float int array object)
isDeleteValue(Page $page, Field $field, mixed $value)
boolIs given value one that should cause the DB row(s) to be deleted rather than saved? 
ready()
(nothing) 
renamedField(Field $field, $prevName)
(nothing)
saveFieldReady(Field $field)
(nothing)
savedField(Field $field)
(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.244

“I am currently managing a ProcessWire site with 2 million+ pages. It’s admirably fast, and much, much faster than any other CMS we tested.” —Nickie, Web developer