$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.

Show $var?             Show args?        

Common

NameReturnSummary 
$fields->clone($item)
bool SaveableCreate and return a cloned copy of the given Field
$fields->delete($item)
boolDelete a Field from the database
$fields->findByTag(string $tag)
arrayReturn all fields that have the given $tag 
$fields->get($key)
Field nullGet a field by name or id
$fields->getNumPages(Field $field)
int arrayReturn a count of pages containing populated values for the given field 
$fields->getNumRows(Field $field)
int arrayReturn a count of database rows populated the given field 
$fields->isNative(string $name)
boolIs the given field name native/permanent to the database? 
$fields->makeItem()
Saveable WireMake an item and populate with given data 
$fields->save($item)
boolSave a Field to the database

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.178

Twitter updates

  • ProcessWire 3.0.179 adds great new admin theme customization tools that put you in full control over the Uikit admin styles— More
    28 May 2021
  • ProcessWire updates for week of 21 May 2021— More
    22 May 2021
  • ProcessWire 3.0.178 focuses largely in adding pull requests (PRs), which are code contributions by ProcessWire users. We had quite a few great pull requests pending, and in total we have added 26 of them in 3.0.178— More
    14 May 2021

Latest news

  • ProcessWire Weekly #369
    In the 369th issue of ProcessWire Weekly we're going to check out the latest core updates, showcase some recent forum highlights and tutorials, and more. Read on!
    Weekly.pw / 5 June 2021
  • ProcessWire 3.0.179 core updates
    ProcessWire 3.0.179 adds great new admin theme customization tools that put you in full control over the admin styles.
    Blog / 28 May 2021
  • 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.