Fieldgroup::remove() method

Remove a field from this fieldgroup

Note that this must be followed up with a $fieldgroup->save() before it does anything destructive. This method does nothing more than queue the removal.

Technical Details
Performs a deletion by finding all templates using this fieldgroup, then finding all pages using the template, then calling upon the Fieldtype to delete them one at a time. This is a potentially expensive/time consuming method, and may need further consideration.

Usage

$bool = $fieldgroup->remove($key);

Arguments

NameType(s)Description
keyField, string

Field object or field name, or id.

Return value

bool

True on success, false on failure.


Fieldgroup methods and properties

API reference based on ProcessWire core version 3.0.244

Latest news

  • ProcessWire Weekly #558
    In the 558th issue of ProcessWire Weekly we'll check out the blog post that introduces ProcessWire 3.0.244, share some recent ProcessWire highlights, and more. Read on!
    Weekly.pw / 18 January 2025
  • ProcessWire 3.0.244 new main/master version
    ProcessWire 3.0.244 is our newest main/master/stable version. It's been more than a year in the making and is packed with tons of new features, issue fixes, optimizations and more. This post covers all the details.
    Blog / 18 January 2025
  • Subscribe to weekly ProcessWire news

“The end client and designer love the ease at which they can update the website. Training beyond how to log in wasn’t even necessary since ProcessWire’s default interface is straightforward.” —Jonathan Lahijani