Pagefile::install() method

Install this Pagefile

Implies copying the file to the correct location (if not already there), and populating its name. The given $filename may be local (path) or external (URL).

Usage

$pagefile->install(string $filename);

Arguments

NameType(s)Description
filenamestring

Full path and filename of file to install, or http/https URL to pull file from.

Exceptions

Method can throw exceptions on error:

  • WireException


Hooking Pagefile::install(…)

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

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

  // Get values of arguments sent to hook (and optionally modify them)
  $filename = $event->arguments(0);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $filename);
});

Hooking after

The 'after' hooks are called immediately after each Pagefile::install(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('Pagefile::install', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $Pagefile = $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)
  $filename = $event->arguments(0);

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

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

Pagefile methods and properties

API reference based on ProcessWire core version 3.0.234

Latest news

  • ProcessWire Weekly #511
    In the 511th issue of ProcessWire Weekly we'll cover the latest core updates, introduce a new third party module called Auto AVIF, and more. Read on!
    Weekly.pw / 25 February 2024
  • Using date range fields in ProcessWire
    This week we'll take a detailed look at the newest addition to the ProFields set of modules: the Date Range Fieldtype and Inputfield.
    Blog / 24 November 2023
  • 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.