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

Twitter updates

  • Introduction to an invoice application profile being built in ProcessWire: More
    30 September 2022
  • Stumbling upon a really nice ProcessWire-powered website, plus core updates including API improvements for ProcessWire forms— More
    9 September 2022
  • Useful new dot-and-bracket syntax options added for page.get() method— More
    2 September 2022

Latest news

  • ProcessWire Weekly #438
    In the 348th issue of ProcessWire Weekly we're going to cover the latest weekly update from Ryan, take a closer look at a couple of new third party modules, and more. Read on!
    Weekly.pw / 1 October 2022
  • Multi-language field translation export/import
    In this post we cover the details of a new module that enables export and import capabilities for multi-language fields in ProcessWire.
    Blog / 5 August 2022
  • Subscribe to weekly ProcessWire news

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright—Marc Hinse, Web designer/developer