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 #556
    In the 556th issue of ProcessWire Weekly we're going to share the latest core development news, highlight a new third party module, and more. Read on!
    Weekly.pw / 4 January 2025
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

“ProcessWire is like a breath of fresh air. So powerful yet simple to build with and customise, and web editors love it too.” —Margaret Chatwin, Web developer