$pages->clone() method

Clone entire page return it.

This also clones any file assets assets associated with the page. The clone is recursive by default, cloning children (and so on) as well. To clone only the page without children, specify false for the $recursive argument.

Warning: this method can fail when recursive and cloning a page with huge amounts of children (or descendent family), and adequate resources (like memory or time limit) are not available.

Example

// Clone the Westin Peachtree skyscraper page
$building = $pages->get('/skyscrapers/atlanta/westin-peachtree/');
$copy = $pages->clone($building);

// Bonus: Now that the clone exists, lets move and rename it
$copy->parent = '/skyscrapers/detroit/';
$copy->title = 'Renaissance Center';
$copy->name = 'renaissance-center';
$copy->save();

Usage

// basic usage
$page = $pages->clone(Page $page);

// usage with all arguments
$page = $pages->clone(Page $page, $parent = null, bool $recursive = true, $options = []);

Arguments

NameType(s)Description
pagePage

Page that you want to clone

parent (optional)Page, null

New parent, if different (default=null, which implies same parent)

recursive (optional)bool

Clone the children too? (default=true)

options (optional)array, string

Options that can be passed to modify default behavior of clone or save:

  • forceID (int): force a specific ID.
  • set (array): Array of properties to set to the clone (you can also do this later).
  • recursionLevel (int): recursion level, for internal use only.

Return value

Page NullPage

The newly cloned Page or a NullPage() with id=0 if unsuccessful.

Exceptions

Method can throw exceptions on error:

  • WireException or \Exception - on fatal error


Hooking $pages->clone(…)

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

$this->addHookBefore('Pages::clone', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $pages = $event->object;

  // Get values of arguments sent to hook (and optionally modify them)
  $page = $event->arguments(0);
  $parent = $event->arguments(1);
  $recursive = $event->arguments(2);
  $options = $event->arguments(3);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $page);
  $event->arguments(1, $parent);
  $event->arguments(2, $recursive);
  $event->arguments(3, $options);
});

Hooking after

The 'after' hooks are called immediately after each $pages->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('Pages::clone', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $pages = $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)
  $page = $event->arguments(0);
  $parent = $event->arguments(1);
  $recursive = $event->arguments(2);
  $options = $event->arguments(3);

  /* Your code here, perhaps modifying the return value */

  // Populate back return value, if you have modified it
  $event->return = $return;
});

$pages methods and properties

API reference based on ProcessWire core version 3.0.135

Twitter updates

  • New post: A look at two new WireMail modules for sending email, plus details on how you can configure ProcessWire to use Gmail for sending email— More
    19 July 2019
  • New post: Version 3.0.135 of ProcessWire on the dev branch focuses on some .htaccess updates, adds clarity to debug mode, and improves upon the installer— More
    5 July 2019
  • ProcessWire 3.0.133 adds a useful new Page::meta() method for a new type of page-specific persistent data storage, adds the ability for users to create their own bookmarks in Lister, and has a handy and time saving update for the asmSelect input type— More
    14 June 2019

Latest news

  • ProcessWire Weekly #271
    In the 271st issue of ProcessWire Weekly we're going to introduce two brand new WireMail modules, a new Textformatter module from BitPoet, and a brand new markup module from Chris Thomson. Read on!
    Weekly.pw / 20 July 2019
  • Two new WireMail modules and using Gmail with PW
    A look at two new WireMail modules for sending email, plus details on how you can configure ProcessWire to use Gmail for sending email.
    Blog / 19 July 2019
  • Subscribe to weekly ProcessWire news

“The end client and designer love the ease at which they can update the website. Training beyond how to log in wasn’t even necessary since ProcessWire’s default interface is straightforward.” —Jonathan Lahijani