$pagecloneReady()

Called right before this page is cloned

Available since version 3.0.253.

Example

$wire->addHook('Page::cloneReady', function($e) {  $page = $e->object;  $e->log->message("Page $page is ready to be cloned"); });

Usage

$page->cloneReady(Page $copy);

Arguments

NameType(s)Description
$copyPage

The copy of this page that it will be cloned to


Hooking $page→cloneReady(…)

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

$this->addHookBefore('Page::cloneReady', function(HookEvent $event) {   // Get the object the event occurred on, if needed   $page = $event->object;    // Get values of arguments sent to hook (and optionally modify them)   $copy = $event->arguments(0);    /* Your code here, perhaps modifying arguments */    // Populate back arguments (if you have modified them)   $event->arguments(0, $copy); });

Hooking after

The 'after' hooks are called immediately after each $page->cloneReady(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('Page::cloneReady', function(HookEvent $event) {   // Get the object the event occurred on, if needed   $page = $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)   $copy = $event->arguments(0);    /* Your code here, perhaps modifying the return value */    // Populate back return value, if you have modified it   $event->return = $return; });

$page methods and properties

API reference based on ProcessWire core version 3.0.255