WireSaveableItems::delete() method

Delete the provided item from the database

Usage

$bool = $wireSaveableItems->delete(Saveable $item);

Arguments

NameType(s)Description
itemSaveable

Item to save

Return value

bool

Returns true on success, false on failure

Exceptions

Method can throw exceptions on error:

  • WireException


Hooking WireSaveableItems::delete(…)

You can add your own hook events that are executed either before or after the WireSaveableItems::delete(…) method is executed. Examples of both are included below. A good place for hook code such as this is in your /site/ready.php file.

Hooking before

The 'before' hooks are called immediately before each WireSaveableItems::delete(…) method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

$this->addHookBefore('WireSaveableItems::delete', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $WireSaveableItems = $event->object;

  // Get values of arguments sent to hook (and optionally modify them)
  $item = $event->arguments(0);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $item);
});

Hooking after

The 'after' hooks are called immediately after each WireSaveableItems::delete(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('WireSaveableItems::delete', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $WireSaveableItems = $event->object;

  // An 'after' hook can retrieve and/or modify the return value
  $return = $event->return;

  // Get values of arguments sent to hook (if needed)
  $item = $event->arguments(0);

  /* Your code here, perhaps modifying the return value */

  // Populate back return value, if you have modified it
  $event->return = $return;
});

WireSaveableItems methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #515
    In the 515th issue of ProcessWire Weekly we’ll check out the latest core updates, new modules, and more. Read on!
    Weekly.pw / 23 March 2024
  • Invoices Site Profile
    The new invoices site profile is a free invoicing application developed in ProcessWire. It enables you to create invoices, record payments to them, email invoices to clients, print invoices, and more. This post covers all the details.
    Blog / 15 March 2024
  • Subscribe to weekly ProcessWire news

I just love the easy and intuitive ProcessWire API. ProcessWire rocks!” —Jens Martsch, Web developer