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

Twitter updates

  • Great video by @jlahijani that demonstrates his ProcessWire page builder using ProFields Repeater Matrix, the new Page Autosave + Live Preview module and Uikit 3— youtube.com/watch?v=Rb5kiU…
    13 November 2021
  • More development on page automatic save this week, plus the addition of live preview— More
    12 November 2021
  • ProcessWire 3.0.189 core updates— More
    5 November 2021

Latest news

  • ProcessWire Weekly #394
    In the 394th issue of ProcessWire Weekly we'll share the latest ProcessWire news and updates, including some highlights from the support forum, the latest weekly update from Ryan, and more. Read on!
    Weekly.pw / 27 November 2021
  • New Repeater and Repeater Matrix features
    This week we have some very useful new additions to both the core Repeater Fieldtype and the ProFields Repeater Matrix Fieldtype. This post covers all the details along with a couple of brief demonstration videos. 
    Blog / 22 October 2021
  • Subscribe to weekly ProcessWire news

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK