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
| Name | Type(s) | Description |
|---|---|---|
item | Pagefile | Pagefile item to duplicate |
options (optional) | array | Options to modify default behavior:
|
Return value
Hooking Pagefiles::clone(…)
You can add your own hook events that are executed either before or after the Pagefiles 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 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 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