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

Twitter updates

  • New post: Quietly and without interruption this week, the ProcessWire.com website (and all subdomains) moved from a single static server to a load-balanced multi-server environment, giving us even more horsepower and redundancy than before— More
    19 April 2019
  • New post: With ProcessWire 3.0.130, this week we’ll take a detailed look at a few useful new API additions made in the last few weeks, along with examples of each—More
    12 April 2019
  • New post: This week ProcessWire ProMailer has been released, plus we’ve got a nice upgrade in our community support forum, and more— More
    15 March 2019

Latest news

  • ProcessWire Weekly #258
    In the 258th issue of ProcessWire Weekly we'll cover a hosting upgrade for the processwire.com site and it's subdomains, introduce PW Review and Terminal module, and feature the new site of O'Neil Cinema. Read on!
    Weekly.pw / 20 April 2019
  • ProcessWire.com website hosting upgrades
    Quietly and without interruption this week, our whole website moved from a single static server to a load-balanced multi-server environment, giving us even more horsepower and redundancy than before.
    Blog / 19 April 2019
  • Subscribe to weekly ProcessWire news

“Indeed, if ProcessWire can be considered as a CMS in its own right, it also offers all the advantages of a CMF (Content Management Framework). Unlike other solutions, the programmer is not forced to follow the proposed model and can integrate his/her ways of doing things.” —Guy Verville, Spiria Digital Inc.