ProcessWire functions

Documentation for procedural functions available in ProcessWire CMS.

Common

Name	Return	Summary
wire() wire() wire(string $name = 'wire')	`mixed`	Return an API variable, or return current ProcessWire instance if given no arguments
wire404() wire404() wire404(string $message = '')	None	Stop execution with a 404 unless redirect URL available (for front-end use)
wireCount() wireCount(mixed $value) wireCount(mixed $value)	`int`	Return the count of item(s) present in the given value
wireDate() wireDate() wireDate($format = '', $ts = null)	`string` `bool`	Format a date, using PHP date(), strftime() or other special strings (see arguments).
wireEmpty() wireEmpty(mixed $value) wireEmpty(mixed $value)	`bool`	Is the given value empty according to ProcessWire standards?
wireInstance() wireInstance() wireInstance($wire = null)	`ProcessWire`	Get or set the current ProcessWire instance
wireLen() wireLen($value) wireLen($value)	`int`	Returns string byte length of any type (string, array, object, bool, int, etc.)
wireLength() wireLength($value) wireLength($value, bool $mb = true)	`int`	Returns string length of any type (string, array, object, bool, int, etc.)
wireMail() wireMail() wireMail($to = '', string $from = '', string $subject = '', $body = '', $options = array)	`int` `WireMail`	Send an email or get a WireMail object to populate before send

Markup

Name	Return	Summary
wireIconMarkup() wireIconMarkup(string $icon) wireIconMarkup(string $icon, string $class = '')	`string`	Render markup for a system icon
wireIconMarkupFile() wireIconMarkupFile(string $filename) wireIconMarkupFile(string $filename, $class = '')	`string`	Get the markup or class name for an icon that can represent the given filename

Strings

Name	Return	Summary
wireBytesStr() wireBytesStr(int $bytes) wireBytesStr(int $bytes, $small = false, $options = array)	`string`	Given a quantity of bytes (int), return readable string that refers to quantity in bytes, kB, MB, GB and TB
wireDate() wireDate() wireDate($format = '', $ts = null)	`string` `bool`	Format a date, using PHP date(), strftime() or other special strings (see arguments).
wirePopulateStringTags() wirePopulateStringTags(string $str, $vars) wirePopulateStringTags(string $str, $vars, array $options = array)	`string`	Given a string ($str) and values ($vars), replace “{tags}” in the string with the values
wireRelativeTimeStr() wireRelativeTimeStr($ts) wireRelativeTimeStr($ts, $abbreviate = false, bool $useTense = true)	`string`	Given a unix timestamp (or date string), returns a formatted string indicating the time relative to now

Arrays

These shortcuts for creating WireArray types are available in ProcessWire 3.0.123 and newer.

Name	Return	Summary
PageArray() PageArray() PageArray($items = array)	`PageArray`	Create new PageArray, add given $items (pages) to it, and return it
WireArray() WireArray() WireArray($items = array)	`WireArray`	Create new WireArray, add given $items to it, and return it
WireData() WireData() WireData($data = array)	`WireData`	Create a new WireData instance and optionally add given associative array of data to it

Functions API

Name	Return	Summary
wire() wire() wire(string $name = 'wire')	`mixed`	Return an API variable, or return current ProcessWire instance if given no arguments

Files

These file system functions are procedural versions of some of those provided by the $files API variable.

Name	Return	Summary
wireChmod() wireChmod(string $path) wireChmod(string $path, bool $recursive = false, string $chmod = null)	`bool`	Change the mode of a file or directory (optionally recursive)
wireCopy() wireCopy(string $src, string $dst) wireCopy(string $src, string $dst, $Array = true)	`bool`	Copy all files recursively from one directory to another
wireIconMarkupFile() wireIconMarkupFile(string $filename) wireIconMarkupFile(string $filename, $class = '')	`string`	Get the markup or class name for an icon that can represent the given filename
wireIncludeFile() wireIncludeFile(string $filename) wireIncludeFile(string $filename, array $vars = array, array $options = include)	`bool`	Include a PHP file passing it all API variables and optionally your own specified variables
wireMkdir() wireMkdir(string $path) wireMkdir(string $path, bool $recursive = false, string $chmod = null)	`bool`	Create a directory (optionally recursively) that is writable to ProcessWire and uses the $config chmod settings
wireRenderFile() wireRenderFile(string $filename) wireRenderFile(string $filename, array $vars = array, array $options = /site/templates/)	`string` `bool`	Given a filename, render it as a ProcessWire template file
wireRmdir() wireRmdir(string $path) wireRmdir(string $path, bool $recursive = false)	`bool`	Remove a directory (optionally recursively)
wireSendFile() wireSendFile(string $filename, array $headers) wireSendFile(string $filename, array $options = array, array $headers)	None	Send the contents of the given filename via http
wireTempDir() wireTempDir($name) wireTempDir($name, $options = array)	`WireTempDir`	Return a new temporary directory/path ready to use for files
wireUnzipFile() wireUnzipFile(string $file, string $dst) wireUnzipFile(string $file, string $dst, array $options = [])	`array`	Unzips the given ZIP file to the destination directory
wireZipFile() wireZipFile(string $zipfile, $files) wireZipFile(string $zipfile, $files, array $options = array)	`array`	Create a ZIP file from given files

Class helpers

Name	Return	Summary
wireClassExists() wireClassExists(string $className) wireClassExists(string $className, bool $autoload = true)	`bool`	Does the given class name exist?
wireClassImplements() wireClassImplements($className) wireClassImplements($className, bool $autoload = true)	`array`	Get an array of all the interfaces that the given class implements
wireClassName() wireClassName($className) wireClassName($className, $withNamespace = false, bool $verbose = false)	`string` `null`	Normalize a class name with or without namespace, or get namespace of class
wireClassNamespace() wireClassNamespace($className) wireClassNamespace($className, bool $withClass = false, bool $strict = false)	`string` `array`	Get namespace for given class
wireClassParents() wireClassParents($className) wireClassParents($className, bool $autoload = true)	`array`	Return array of all parent classes for given class/object
wireInstanceOf() wireInstanceOf($instance, $className) wireInstanceOf($instance, $className, bool $autoload = true)	`bool` `string`	Does given instance (or class) represent an instance of the given className (or class names)?
wireIsCallable() wireIsCallable($var) wireIsCallable($var, bool $syntaxOnly = false)	`bool`	Is the given $var callable as a function?
wireMethodExists() wireMethodExists(string $className, string $method) wireMethodExists(string $className, string $method, bool $hookable = false)	`bool`	Does the given class have the given method?

API reference based on ProcessWire core version 3.0.259