$fields API variable / Fields class

Manages all custom fields in ProcessWire, independently of any Fieldgroup.

Each field returned is an object of type Field. The $fields API variable is iterable:

foreach($fields as $field) {
  echo "<p>Name: $field->name, Type: $field->type, Label: $field->label</p>";
}

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

Common

Name	Return	Summary
$fields->applySetupName() $fields->applySetupName(Field $field) $fields->applySetupName(Field $field, $setupName = '')	`bool`
$fields->clone() $fields->clone(Field $item) $fields->clone(Field $item, string $name = '')	`Field`	Create and return a cloned copy of the given Field
$fields->delete() $fields->delete(Field $item) $fields->delete(Field $item)	`bool`	Delete a Field from the database
$fields->findByTag() $fields->findByTag(string $tag) $fields->findByTag(string $tag, bool $getFieldNames = false)	`array`	Return all fields that have the given $tag
$fields->findByType() $fields->findByType($type) $fields->findByType($type, array $options = [])	`array` `Field`	Find fields by type
$fields->get() $fields->get($key) $fields->get($key)	`Field` `null`	Get a field by name or id
$fields->getAllNames() $fields->getAllNames() $fields->getAllNames(string $indexType = '')	`array`	Get all field names
$fields->getCacheItemName() $fields->getCacheItemName() $fields->getCacheItemName()	(nothing)
$fields->getNumPages() $fields->getNumPages(Field $field) $fields->getNumPages(Field $field, array $options = [])	`int` `array`	Return a count of pages containing populated values for the given field
$fields->getNumRows() $fields->getNumRows(Field $field) $fields->getNumRows(Field $field, array $options = [])	`int` `array`	Return a count of database rows populated the given field
$fields->getWireArray() $fields->getWireArray() $fields->getWireArray()	`WireArray`	Get WireArray container that items are stored in
$fields->isNative() $fields->isNative(string $name) $fields->isNative(string $name)	`bool`	Is the given field name native/permanent to the database?
$fields->makeItem() $fields->makeItem() $fields->makeItem(array $a = [])	`Saveable` `Wire`	Make an item and populate with given data
$fields->save() $fields->save(Field $item) $fields->save(Field $item)	`bool`	Save a Field to the database

Advanced

Name	Return	Summary
$fields->getTags() $fields->getTags() $fields->getTags($getFieldNames = false)	`array`	Get list of all tags used by fields
$fields->saveFieldgroupContext() $fields->saveFieldgroupContext(Field $field, Fieldgroup $fieldgroup) $fields->saveFieldgroupContext(Field $field, Fieldgroup $fieldgroup, string $namespace = '')	`bool`	Save the context of the given field for the given fieldgroup

For hooks

These methods are only useful for hooking and should not be called directly.

Name	Return	Summary
$fields->changeFieldtype() $fields->changeFieldtype(Field $field1) $fields->changeFieldtype(Field $field1, bool $keepSettings = false)	`bool`	Change a field's type
$fields->changeTypeReady() $fields->changeTypeReady(Field $item, Fieldtype $fromType, Fieldtype $toType) $fields->changeTypeReady(Field $item, Fieldtype $fromType, Fieldtype $toType)	(nothing)	Hook called right before a field is about to change type
$fields->changedType() $fields->changedType(Field $item, Fieldtype $fromType, Fieldtype $toType) $fields->changedType(Field $item, Fieldtype $fromType, Fieldtype $toType)	(nothing)	Hook called when a field has changed type
$fields->deleteFieldDataByTemplate() $fields->deleteFieldDataByTemplate(Field $field, Template $template) $fields->deleteFieldDataByTemplate(Field $field, Template $template)	`bool`	Physically delete all field data (from the database) used by pages of a given template

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.244

$fields API variable / Fields class

Manages all custom fields in ProcessWire, independently of any Fieldgroup.

Common

Advanced

For hooks

Additional methods and properties

Newest forum posts

Latest news

Subscribe to weekly ProcessWire news