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.
Common
| Name | Return | Summary | |
|---|
FieldtypeModule::getBlankValue(Page $page, Field $field) | bool int null ModulePlaceholder | Get blank value | |
FieldtypeModule::getCompatibleFieldtypes(Field $field) | Fieldtypes | Get compatible Fieldtypes | |
FieldtypeModule::getConfigInputfields(Field $field) | InputfieldWrapper | Configure field | |
FieldtypeModule::getDatabaseSchema(Field $field) | array | Get database schema | |
FieldtypeModule::getInputfield(Page $page, Field $field) | Inputfield | Get Inputfield | |
FieldtypeModule::getMatchQuery(PageFinderDatabaseQuerySelect $query, string $table, string $subfield, string $operator, mixed $value) | PageFinderDatabaseQuerySelect DatabaseQuerySelect | Get the database query that matches a Fieldtype table’s data with a given value. | |
FieldtypeModule::getSelectableModules(Field $field) | array | Get all selectable modules for given field | |
FieldtypeModule::getSelectorInfo(Field $field) | array | Return array with information about what properties and operators can be used with this field. | |
FieldtypeModule::isAdvanced() | bool | Should this Fieldtype only be allowed for new fields in advanced mode? | |
FieldtypeModule::markupValue(Page $page, Field $field) | string | Render a markup string of the value. | |
FieldtypeModule::sanitizeValue(Page $page, Field $field, $value) | int bool null Module | Sanitize value | |
FieldtypeModule::sleepValue(Page $page, Field $field, $value) | int | Sleep value | |
FieldtypeModule::wakeupValue(Page $page, Field $field, $value) | string | Wakeup 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.255