Pagefiles::delete() method

Delete a pagefile item

Deletes the filename associated with the Pagefile and removes it from this Pagefiles array. The actual deletion of the file does not take effect until $page->save().

Usage

$pagefiles->delete($item);

Arguments

NameType(s)Description
itemPagefile, string

Pagefile or basename

Return value

$this

Object instance it was called from (method supports fluent interface).


Hooking Pagefiles::delete(…)

You can add your own hook events that are executed either before or after the Pagefiles::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 Pagefiles::delete(…) method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

$this->addHookBefore('Pagefiles::delete', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $Pagefiles = $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 Pagefiles::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('Pagefiles::delete', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $Pagefiles = $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;
});

Pagefiles methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #544
    In the 150th issue of ProcessWire Weekly we'll check out brand-new third party module called Inputfield Dependency Helper, share some recent highlights from the support forum, and more. Read on!
    Weekly.pw / 12 October 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

“…building with ProcessWire was a breeze, I really love all the flexibility the system provides. I can’t imagine using any other CMS in the future.” —Thomas Aull