wireTempDir() function

Return a new temporary directory/path ready to use for files

  • The directory will be automatically removed after a set period of time (default=120s).
  • This is a procedural version of the $files->tempDir() method.

Example

$td = wireTempDir('hello-world');
$path = (string) $td; // or use $td->get();
file_put_contents($path . 'some-file.txt', 'Hello world');

Usage

// basic usage
$wireTempDir = wireTempDir($name);

// usage with all arguments
$wireTempDir = wireTempDir($name, $options = array);

Arguments

NameType(s)Description
nameObject, string

Provide the object that needs the temp dir, or name your own string

options (optional)array, int

Options array to modify default behavior:

  • maxAge (integer): Maximum age of temp dir files in seconds (default=120)
  • basePath (string): Base path where temp dirs should be created. Omit to use default (recommended).
  • Note: if you specify an integer for $options, then 'maxAge' is assumed.

Return value

WireTempDir

If you typecast return value to a string, it is the temp dir path (with trailing slash).

See Also


Functions methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #522
    In the 522nd issue of ProcessWire Weekly we'll check out the latest core updates, introduce a new module called File Mover, and more. Read on!
    Weekly.pw / 11 May 2024
  • ProFields Table Field with Actions support
    This week we have some updates for the ProFields table field (FieldtypeTable). These updates are primarily focused on adding new tools for the editor to facilitate input and management of content in a table field.
    Blog / 12 April 2024
  • Subscribe to weekly ProcessWire news

I just love the easy and intuitive ProcessWire API. ProcessWire rocks!” —Jens Martsch, Web developer