wireRenderFile() function

Given a filename, render it as a ProcessWire template file

This is a shortcut to using the TemplateFile class, as well as the procedural version of $files->render().

File is assumed relative to /site/templates/ (or a directory within there) unless you specify a full path. If you specify a full path, it will accept files in or below any of the following:

  • /site/templates/
  • /site/modules/
  • /wire/modules/

Note this function returns the output to you, so that you can send the output wherever you want (delayed output). For direct output, use the wireIncludeFile() or $files->include() function instead.

Usage

// basic usage
$string = wireRenderFile(string $filename);

// usage with all arguments
$string = wireRenderFile(string $filename, array $vars = array, array $options = /site/templates/);

Arguments

NameType(s)Description
filenamestring

Assumed relative to /site/templates/ unless you provide a full path name with the filename. If you provide a path, it must resolve somewhere in site/templates/, site/modules/ or wire/modules/.

vars (optional)array

Optional associative array of variables to send to template file. Please note that all template files automatically receive all API variables already (you don't have to provide them).

options (optional)array

Associative array of options to modify behavior:

  • defaultPath (string): Path where files are assumed to be when only filename or relative filename is specified (default=/site/templates/)
  • autoExtension (string): Extension to assume when no ext in filename, make blank for no auto assumption (default=php)
  • allowedPaths (array): Array of paths that are allowed (default is templates, core modules and site modules)
  • allowDotDot (bool): Allow use of ".." in paths? (default=false)
  • throwExceptions (bool): Throw exceptions when fatal error occurs? (default=true)

Return value

string bool

Rendered template file or boolean false on fatal error (and throwExceptions disabled)

Exceptions

Method can throw exceptions on error:

  • WireException - if template file doesn’t exist

See Also


Functions methods and properties

API reference based on ProcessWire core version 3.0.200

Twitter updates

  • New blog: Debugging tools built-in to ProcessWire. ProcessWire's core comes with a lot of helpful debugging tools and capabilities built-in. In this post we'll cover some of these useful tools and how to use them… More
    1 July 2022
  • A review of weekly core updates, plus a simple recipe for a very effective listing cache—More
    24 June 2022
  • Weekly update: Making ProcessWire render pages at old WordPress URLs (or building a simple/custom URL router in PW): More
    17 June 2022

Latest news

  • ProcessWire Weekly #424
    In the 424th issue of ProcessWire Weekly we'll check out the latest weekly update from Ryan, introduce a new third party module, and more. Read on!
    Weekly.pw / 25 June 2022
  • Debugging tools built into ProcessWire
    ProcessWire's core comes with a lot of helpful debugging tools and capabilities built-in. In this post we'll cover some of these useful tools and how to use them.
    Blog / 1 July 2022
  • Subscribe to weekly ProcessWire news

“To Drupal, or to ProcessWire? The million dollar choice. We decided to make an early switch to PW. And in retrospect, ProcessWire was probably the best decision we made. Thanks are due to ProcessWire and the amazing system and set of modules that are in place.” —Unni Krishnan, Founder of PigtailPundits