WireTempDir::init() method

Initialize temporary directory

This method should only be called once per instance of this class. If you specified a $name argument in the constructor, then you should not call this method because it will have already been called.

Usage

// basic usage
$string = $wireTempDir->init();

// usage with all arguments
$string = $wireTempDir->init($name = '', string $basePath = '');

Arguments

NameType(s)Description
name (optional)string, object

Recommend providing the object that is using the temp dir, but can also be any string

basePath (optional)string

Base path where temp dirs should be created. Omit to use default (recommended).

Return value

string

Returns the root of the temporary directory. Use the get() method to get a dir for use.

Exceptions

Method can throw exceptions on error:

  • WireException - if given a $root that doesn't exist


WireTempDir methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #550
    In the 550th issue of ProcessWire Weekly we're going to check out the latest core updates, introduce a new third party module called PagefileMetadata, and more. Read on!
    Weekly.pw / 23 November 2024
  • 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

“The end client and designer love the ease at which they can update the website. Training beyond how to log in wasn’t even necessary since ProcessWire’s default interface is straightforward.” —Jonathan Lahijani