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

Twitter updates

  • This week we’ve got a couple of really useful API-side improvements to the core in 3.0.151, including predefined image settings and static language translation improvements— More
    21 February 2020
  • New post in the blog about all the fun we had driving around a DDOS attack on our forums, how we got it back under control, and what we learned along the way. Plus PW 3.0.150 dev details and links! More
    7 February 2020
  • New post: ProcessWire core updates (January 31, 2020)— More
    31 January 2020

Latest news

  • ProcessWire Weekly #302
    In the 302nd issue of ProcessWire Weekly we're going to dig into ProcessWire 3.0.151, introduce a new third party module called PrivacyWire, and showcase some interesting ProcessWire highlights from the past week or so. Read on!
    Weekly.pw / 22 February 2020
  • ProcessWire 3.0.151 core updates
    Blog / 21 February 2020
  • Subscribe to weekly ProcessWire news

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright—Marc Hinse, Web designer/developer