FieldtypeModule class

Field that stores a reference to another module

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

Show class?             Show args?        

Common

NameReturnSummary 
FieldtypeModule::getBlankValue(Page $page, Field $field)
bool int null ModulePlaceholderGet blank value 
FieldtypeModule::getCompatibleFieldtypes(Field $field)
FieldtypesGet compatible Fieldtypes
FieldtypeModule::getConfigInputfields(Field $field)
InputfieldWrapperConfigure field
FieldtypeModule::getDatabaseSchema(Field $field)
arrayGet database schema 
FieldtypeModule::getInputfield(Page $page, Field $field)
InputfieldGet Inputfield 
FieldtypeModule::getMatchQuery(PageFinderDatabaseQuerySelect $query, string $table, string $subfield, string $operator, mixed $value)
PageFinderDatabaseQuerySelect DatabaseQuerySelectGet the database query that matches a Fieldtype table’s data with a given value. 
FieldtypeModule::getSelectableModules(Field $field)
arrayGet all selectable modules for given field 
FieldtypeModule::getSelectorInfo(Field $field)
arrayReturn array with information about what properties and operators can be used with this field.
FieldtypeModule::isAdvanced()
boolShould this Fieldtype only be allowed for new fields in advanced mode? 
FieldtypeModule::markupValue(Page $page, Field $field)
stringRender a markup string of the value.
FieldtypeModule::sanitizeValue(Page $page, Field $field, $value)
int bool null ModuleSanitize value 
FieldtypeModule::sleepValue(Page $page, Field $field, $value)
intSleep value
FieldtypeModule::wakeupValue(Page $page, Field $field, $value)
stringWakeup value

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #550
    In the 550th issue of ProcessWire Weekly we're going to check out the latest core updates, introduce a new third party module called PagefileMetadata, and more. Read on!
    Weekly.pw / 23 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

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