Fieldtypes / $fieldtypes

get($name)

Return a Fieldtype module for the given name. The name can be provided with or without the Fieldtype prefix, and module-name matching is case-insensitive.

// All of these return the same FieldtypeText instance
$ft = $fieldtypes->get('FieldtypeText');
$ft = $fieldtypes->get('text');

// Other examples
$ft = $fieldtypes->get('FieldtypePage');
$ft = $fieldtypes->get('page');
$ft = $fieldtypes->get('image'); // FieldtypeImage

If the requested fieldtype is installed but not yet loaded, get() resolves the module automatically. Like $modules->get(), it can also install an available but uninstalled Fieldtype module. It returns null when no matching module can be loaded or installed.

Because Fieldtypes implements magic __get(), you can also access common fieldtypes as object properties:

$text = $fieldtypes->FieldtypeText;
$text = $fieldtypes->text;
$file = $fieldtypes->file;
$url  = $fieldtypes->URL;

has($name)

Check whether the collection contains a fieldtype. Pass its full class name; unlike get(), this method does not resolve short aliases or load modules.

if($fieldtypes->has('FieldtypeComments')) {
    // Comments fieldtype is available
}

Iterating all fieldtypes

foreach($fieldtypes as $className => $fieldtype) {
    echo "<li>$className</li>";
}

The PHPDoc for Fieldtypes exposes shorthand properties for the most common fieldtypes. Some properties have a |null type because the corresponding bundled Fieldtype module can be unavailable when it has not been installed. This indicates availability, not a Pro module.

You can still access any installed fieldtype by its full class name even if it is not listed above.

• API variable: $fieldtypes
• Source file: wire/core/Fieldtypes/Fieldtypes.php
• Extends: WireArray
• Instantiation: ProcessWire builds this collection during bootstrap via $fieldtypes->init(); you normally access it through the $fieldtypes API variable rather than constructing it yourself.
• Indexed by: each fieldtype's className() value (e.g. FieldtypeText).
• Auto-resolution: get() loads an installed module on demand and may install an available but uninstalled module.
• Related: Fieldtype, FieldtypeMulti, Fields, Field