WireTempDir class

Located in file /wire/core/WireTempDir.php

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the WireTempDir class also inherits all the methods and properties of: Wire.

Common

Name	Return	Summary
WireTempDir::create() WireTempDir::create() WireTempDir::create(string $name = '', string $basePath = '')	`string`	@deprecated Use init() method instead
WireTempDir::createName() WireTempDir::createName() WireTempDir::createName(string $prefix = '')	`string`	Create a randomized name for runtime temp dir
WireTempDir::get() WireTempDir::get() WireTempDir::get(string $id = '')	`string`	Returns a temporary directory (path)
WireTempDir::init() WireTempDir::init() WireTempDir::init($name = '', string $basePath = '')	`string`	Initialize temporary directory
WireTempDir::maintenance() WireTempDir::maintenance() WireTempDir::maintenance()	`bool`	Perform maintenance by cleaning up old temporary directories
WireTempDir::remove() WireTempDir::remove() WireTempDir::remove()	`bool`	Removes the temporary directory created by this object
WireTempDir::removeAll() WireTempDir::removeAll() WireTempDir::removeAll()	(nothing)	Clear all temporary directories created by this class
WireTempDir::setRemove() WireTempDir::setRemove() WireTempDir::setRemove(bool $remove = true)	`$this`	Call this with 'false' to prevent temp dir from being removed automatically when object is destructed

Additional methods and properties

In addition to the methods and properties above, WireTempDir also inherits the methods and properties of these classes:

Wire

API reference based on ProcessWire core version 3.0.236

Located in file /wire/core/WireTempDir.php

Common

Additional methods and properties

Newest forum posts

Latest news

Subscribe to weekly ProcessWire news