$buster→url()

Get a cache busting URL for given asset/file URL

If given a URL including scheme+hostname then it will be retained in the returned URL.

Usage

// basic usage
$string = $buster->url(string $url);

// usage with all arguments
$string = $buster->url(string $url, array $options = []);

Arguments

NameType(s)Description
$urlstring

Full URL to file (hostname optional)

$options (optional)array
  • mtime (int): Modification time to use for file as unix timestamp. Default:0, which means auto-detect
  • file (string): Filename with disk path to determine mtime from. Default:auto detect from URL
  • str (string): Version string to fall-back to if URL from file cannot be located and no mtime available. Default:none
  • of (bool): Output formatting, TRUE if URL to be encoded for use in HTML, only matters if "&" comes into play. Default:true

Return value

string

URL modified with cache busting string in query string

$buster methods and properties

API reference based on ProcessWire core version 3.0.252