FieldtypeMulti class

Located in file /wire/core/FieldtypeMulti.php

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

Show class?             Show args?        

Common

NameReturnSummary 
FieldtypeMulti::deletePageFieldRows(Page $page, Field $field, $value)
int
FieldtypeMulti::getBlankValue(Page $page, Field $field)
WireArrayPer Fieldtype interface, return a blank value of this Fieldtype 
FieldtypeMulti::getCompatibleFieldtypes(Field $field)
Fieldtypes nullGet an array of Fieldtypes that are compatible with this one (i.e. ones the user may change the type to)
FieldtypeMulti::getDatabaseSchema(Field $field)
arrayModify the default schema provided by Fieldtype to include a 'sort' field, and integrate that into the primary key. 
FieldtypeMulti::getLoadQueryAutojoin(Field $field, DatabaseQuerySelect $query)
DatabaseQuerySelect nullReturn the query used for Autojoining this field (if different from getLoadQuery) or NULL if autojoin not allowed. 
FieldtypeMulti::getMatchQuery(PageFinderDatabaseQuerySelect $query, string $table, string $subfield, string $operator, mixed $value)
PageFinderDatabaseQuerySelect DatabaseQuerySelectGet the query that matches a Fieldtype table's data with a given value 
FieldtypeMulti::getSelectorInfo(Field $field)
arrayReturn array with information about what properties and operators can be used with this field
FieldtypeMulti::sanitizeValue(Page $page, Field $field, mixed $value)
WireArrayPer the Fieldtype interface, sanitize the combined value for use in a Page 
FieldtypeMulti::savePageField(Page $page, Field $field)
boolPer the Fieldtype interface, Save the given Field from the given Page to the database
FieldtypeMulti::savePageFieldRows(Page $page, Field $field, $value)
bool
FieldtypeMulti::sleepValue(Page $page, Field $field, WireArray $value)
arrayGiven an 'awake' value, as set by wakeupValue, convert the value back to a basic type for storage in DB.
FieldtypeMulti::wakeupValue(Page $page, Field $field, array $value)
WireArrayProcess the value to convert it from array to whatever object it needs to be

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #515
    In the 515th issue of ProcessWire Weekly we’ll check out the latest core updates, new modules, and more. Read on!
    Weekly.pw / 23 March 2024
  • Invoices Site Profile
    The new invoices site profile is a free invoicing application developed in ProcessWire. It enables you to create invoices, record payments to them, email invoices to clients, print invoices, and more. This post covers all the details.
    Blog / 15 March 2024
  • Subscribe to weekly ProcessWire news

“Indeed, if ProcessWire can be considered as a CMS in its own right, it also offers all the advantages of a CMF (Content Management Framework). Unlike other solutions, the programmer is not forced to follow the proposed model and can integrate his/her ways of doing things.” —Guy Verville, Spiria Digital Inc.