$files->send() method

Send the contents of the given filename to the current http connection

This function utilizes the $config->fileContentTypes to match file extension to content type headers and force-download state.

This function throws a WireException if the file can’t be sent for some reason. Set the throw option to false if you want it to instead return integer 0 when errors occur.

Usage

// basic usage
$int = $files->send($filename);

// usage with all arguments
$int = $files->send($filename, array $options = [], array $headers = []);

Arguments

NameType(s)Description
filenamestring, bool

Full path and filename to send or boolean false if provided in $options[data].

options (optional)array

Optional options to modify default behavior:

  • exit (bool): Halt program execution after file send (default=true).
  • partial (bool): Allow use of partial downloads via HTTP_RANGE requests? Since 3.0.131 (default=true)
  • forceDownload (bool|null): Whether file should force download, or null to let content-type header decide (default=null).
  • downloadFilename (string): Filename you want the download to show on user’s computer, or omit to use existing (default='').
  • headers (array): The $headers argument to this method can also be provided as an option right here (default=[]). Since 3.0.131.
  • data (string): String of data to send rather than file, $filename argument must be false (default=''). Since 3.0.132.
  • limitPath (string|bool): Prefix disk path $filename must be within, false to disable, true for site/assets (default=false). Since 3.0.169.
  • throw (bool): Throw exceptions on error? When false, it will instead return integer 0 on errors (default=true). Since 3.0.169.
headers (optional)array

Optional headers that are sent, below are the defaults:

  • pragma: public
  • expires: 0
  • cache-control: must-revalidate, post-check=0, pre-check=0
  • content-type: {content-type} (replaced with actual content type)
  • content-transfer-encoding: binary
  • content-length: {filesize} (replaced with actual filesize)
  • To remove a header completely, make its value NULL.
  • If preferred, the above headers can be specified in $options[headers] instead.

Return value

int

Returns bytes sent, only if exit option is false (since 3.0.169)

Exceptions

Method can throw exceptions on error:

  • WireException

See Also


$files methods and properties

API reference based on ProcessWire core version 3.0.200

Twitter updates

  • New TinyMCE 6.2.0 Inputfield released for ProcessWire— More
    28 October 2022
  • This week we take a look at a new rich text editor for ProcessWire, why we chose it, some highlights, screenshots, and why we think you’ll like it— More
    21 October 2022
  • This week we have ProcessWire 3.0.206 on the dev branch and a new version of the ProDevTools UserActivity module, which we'll take a closer look at in this post— More
    7 October 2022

Latest news

  • ProcessWire Weekly #445
    In the 445th issue of ProcessWire Weekly we're going to check out the latest core updates, the latest weekly update from Ryan, new third party module called InlineCompleteTinyMCE, and more. Read on!
    Weekly.pw / 20 November 2022
  • New rich text editor for ProcessWire
    This week we take a look at a new rich text editor for ProcessWire, why we chose it, some highlights, screenshots, and why we think you’ll like it.
    Blog / 21 October 2022
  • Subscribe to weekly ProcessWire news

“The end client and designer love the ease at which they can update the website. Training beyond how to log in wasn’t even necessary since ProcessWire’s default interface is straightforward.” —Jonathan Lahijani