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.

Please note this method is and thus not intended to be called directly.

Example

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

Internal usage

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

// internal 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.251