$fieldtypes

Maintains a collection of Fieldtype modules.

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

Show $var?     Show args?       Only hookable?    

Common

NameReturnSummary 
$fieldtypes->eq($num)
None 
$fieldtypes->first()
None 
$fieldtypes->get(string $key)
Fieldtype null

Given a Fieldtype name (or class name) return the instantiated Fieldtype module.

 
$fieldtypes->getAll()
None 
$fieldtypes->getArray()
None

Below we account for all get() related functions in WireArray to preload the fieldtypes

 
$fieldtypes->getItemKey(Fieldtype $item)
string

Per the WireArray interface, Fields are indxed by their name

 
$fieldtypes->getIterator()
None 
$fieldtypes->getNext($item)
None 
$fieldtypes->getPrev($item)
None 
$fieldtypes->getRandom()
None 
$fieldtypes->getValues()
None 
$fieldtypes->init()
None

Construct the $fieldtypes API var (load all Fieldtype modules into it)

 
$fieldtypes->isValidItem($item)
bool

Per WireArray interface, items added to Fieldtypes must be Fieldtype instances

 
$fieldtypes->isValidKey($key)
bool

Per the WireArray interface, keys must be strings (fieldtype class names)

 
$fieldtypes->last()
None 
$fieldtypes->makeBlankItem()
null

Per the WireArray interface, return a blank copy

 
$fieldtypes->makeCopy()
None 
$fieldtypes->makeNew()
None 
$fieldtypes->pop()
None 
$fieldtypes->shift()
None 
$fieldtypes->slice($start)
None 
$fieldtypes->sort($properties)
None 

Properties

NameReturnSummary 
$fieldtypes->FieldtypeCheckbox FieldtypeCheckbox 
$fieldtypes->FieldtypeComments FieldtypeComments null 
$fieldtypes->FieldtypeDatetime FieldtypeDatetime 
$fieldtypes->FieldtypeEmail FieldtypeEmail 
$fieldtypes->FieldtypeFile FieldtypeFile 
$fieldtypes->FieldtypeFloat FieldtypeFloat 
$fieldtypes->FieldtypeImage FieldtypeImage 
$fieldtypes->FieldtypeInteger FieldtypeInteger 
$fieldtypes->FieldtypeModule FieldtypeModule 
$fieldtypes->FieldtypeOptions FieldtypeOptions null 
$fieldtypes->FieldtypePage FieldtypePage 
$fieldtypes->FieldtypePageTable FieldtypePageTable 
$fieldtypes->FieldtypePageTitle FieldtypePageTitle 
$fieldtypes->FieldtypePassword FieldtypePassword 
$fieldtypes->FieldtypeRepeater FieldtypeRepeater null 
$fieldtypes->FieldtypeSelector FieldtypeSelector null 
$fieldtypes->FieldtypeText FieldtypeText 
$fieldtypes->FieldtypeTextarea FieldtypeTextarea 
$fieldtypes->FieldtypeToggle FieldtypeToggle null 
$fieldtypes->FieldtypeURL FieldtypeURL 
$fieldtypes->URL FieldtypeURL 
$fieldtypes->checkbox FieldtypeCheckbox 
$fieldtypes->comments FieldtypeComments null 
$fieldtypes->datetime FieldtypeDatetime 
$fieldtypes->email FieldtypeEmail 
$fieldtypes->file FieldtypeFile 
$fieldtypes->float FieldtypeFloat 
$fieldtypes->image FieldtypeImage 
$fieldtypes->integer FieldtypeInteger 
$fieldtypes->module FieldtypeModule 
$fieldtypes->options FieldtypeOptions null 
$fieldtypes->page FieldtypePage 
$fieldtypes->pageTable FieldtypePageTable 
$fieldtypes->pageTitle FieldtypePageTitle 
$fieldtypes->password FieldtypePassword 
$fieldtypes->repeater FieldtypeRepeater null 
$fieldtypes->selector FieldtypeSelector null 
$fieldtypes->text FieldtypeText 
$fieldtypes->textarea FieldtypeTextarea 
$fieldtypes->toggle FieldtypeToggle null 

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.252