Pagefiles::clone() method

Duplicate the Pagefile and add to this Pagefiles instance

After duplicating a file, you must follow up with a save of the page containing it. Otherwise the file is marked for deletion.

Usage

// basic usage
$pagefile = $pagefiles->clone(Pagefile $item);

// usage with all arguments
$pagefile = $pagefiles->clone(Pagefile $item, array $options = []);

Arguments

NameType(s)Description
itemPagefile

Pagefile item to duplicate

options (optional)array

Options to modify default behavior:

  • action (string): Specify "append", "prepend", "after", "before" or blank to only return Pagefile. (default="after")
  • pagefiles (Pagefiles): Pagefiles instance file should be duplicated to. (default=$this)

Return value

Pagefile bool

Returns new Pagefile or boolean false on fail


Hooking Pagefiles::clone(…)

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

$this->addHookBefore('Pagefiles::clone', 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);
  $options = $event->arguments(1);

  /* Your code here, perhaps modifying arguments */

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

Hooking after

The 'after' hooks are called immediately after each Pagefiles::clone(…) 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::clone', 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);
  $options = $event->arguments(1);

  /* 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 #543
    In the 543rd issue of ProcessWire Weekly we'll check out the latest weekly update from Ryan, introduce a couple of new third party modules — both authored by Bernhard Baumrock — and more. Read on!
    Weekly.pw / 5 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

“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