WireHttp::download() method

Download a file from a URL and save it locally

First it will attempt to use CURL. If that fails, it will try fopen(), unless you specify the use option in $options.

Usage

// basic usage
$string = $http->download(string $fromURL, string $toFile);

// usage with all arguments
$string = $http->download(string $fromURL, string $toFile, array $options = []);

Arguments

NameType(s)Description
fromURLstring

URL of file you want to download.

toFilestring

Filename you want to save it to (including full path).

options (optional)array

Optional aptions array for PHP's stream_context_create(), plus these optional options:

  • use or useMethod (string): Specify "curl", "fopen" or "socket" to force a specific method (default=auto-detect).
  • timeout (float): Number of seconds till timeout.

Return value

string

Filename that was downloaded (including full path).

Exceptions

Method can throw exceptions on error:

  • WireException - All error conditions throw exceptions.


Hooking $http->download(…)

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

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

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

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $fromURL);
  $event->arguments(1, $toFile);
  $event->arguments(2, $options);
});

Hooking after

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

$this->addHookAfter('WireHttp::download', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $WireHttp = $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)
  $fromURL = $event->arguments(0);
  $toFile = $event->arguments(1);
  $options = $event->arguments(2);

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

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

$http methods and properties

API reference based on ProcessWire core version 3.0.148

Twitter updates

  • ProcessWire 3.0.153 (dev) focuses on comments field updates, significant refactoring/improvements to ProcessWire’s core Template class and PagesLoader class (which is used by the pages API variable), and we introduce a useful new pages API method— More
    20 March 2020
  • ProcessWire 3.0.152 core updates— This week we have some major improvements to our core date/time Inputfield, as well as a new ability to specify your own custom classes for Page objects— More
    6 March 2020
  • 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

Latest news

  • ProcessWire Weekly #307
    In the 307th issue of ProcessWire Weekly we're going to check out the latest dev branch updates, introduce some new third party modules, and more. Read on!
    Weekly.pw / 28 March 2020
  • ProcessWire 3.0.153 core updates
    This latest version of the core on the dev branch focuses on comments field updates, significant refactoring/improvements to ProcessWire’s core Template class and PagesLoader class (which is used by the $pages API variable), and we introduce a useful new $pages API method.
    Blog / 20 March 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