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

Latest news

  • ProcessWire Weekly #555
    In the 555th issue of ProcessWire Weekly we're going to check out the latest core updates, introduce a new third party module that adds the ability to automatically convert email messages to pages, and more. Read on!
    Weekly.pw / 28 December 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

“To Drupal, or to ProcessWire? The million dollar choice. We decided to make an early switch to PW. And in retrospect, ProcessWire was probably the best decision we made. Thanks are due to ProcessWire and the amazing system and set of modules that are in place.” —Unni Krishnan, Founder of PigtailPundits