Get or set an output region (primarily for front-end output usage)

This function is an convenience for storing markup that ultimately gets output in a _main.php file (or whatever file $config->appendTemplateFile is set to). It is an alternative to passing variables between included files and provides an interface for setting, appending, prepending and ultimately getting markup (or other strings) for output. It’s designed for use the the “Delayed Output” strategy, though does not necessarily require it.

This function can also be accessed as wireRegion(), and that function is always available regardless of whether the Functions API is enabled or not.

Note: unlike other functions in the Functions API, this function is not related to API variables.

Example

// define a region
region('content', '<p>this is some content</p>');

// prepend some text to region
region('+content', '<h2>Good morning</h2>');

// append some text to region
region('content+', '<p><small>Good night</small></p>');

// output a region
echo region('content');

// get all regions in an array
$regions = region('*');

// clear the 'content' region
region('content', '');

// clear all regions
region('*', '');

Usage

// basic usage
$string = region();

// usage with all arguments
$string = region(string $key = '', $value = null);

Arguments

NameType(s)Description
key (optional)string

Name of region to get or set.

  • Specify "*" to retrieve all defined regions in an array.
  • Prepend a "+" to the region name to have it prepend your given value to any existing value.
  • Append a "+" to the region name to have it append your given value to any existing value.
  • Prepend a "++" to region name to make future calls without "+" automatically prepend.
  • Append a "++" to region name to make future calls without "+" to automatically append.
value (optional)null, string

If setting a region, the text that you want to set.

Return value

string null bool array

Returns string of text when getting a region, NULL if region not set, or TRUE if setting region.


Functions methods and properties

API reference based on ProcessWire core version 3.0.148

Twitter updates

  • ProcessWire 3.0.153 (dev) focuses on comments field updates, significant refactoring/improvements to ProcessWire’s core Template class and PagesLoader class (which is used by the pages API variable), and we introduce a useful new pages API method— More
    20 March 2020
  • ProcessWire 3.0.152 core updates— This week we have some major improvements to our core date/time Inputfield, as well as a new ability to specify your own custom classes for Page objects— More
    6 March 2020
  • This week we’ve got a couple of really useful API-side improvements to the core in 3.0.151, including predefined image settings and static language translation improvements— More
    21 February 2020

Latest news

  • ProcessWire Weekly #307
    In the 307th issue of ProcessWire Weekly we're going to check out the latest dev branch updates, introduce some new third party modules, and more. Read on!
    Weekly.pw / 28 March 2020
  • ProcessWire 3.0.153 core updates
    This latest version of the core on the dev branch focuses on comments field updates, significant refactoring/improvements to ProcessWire’s core Template class and PagesLoader class (which is used by the $pages API variable), and we introduce a useful new $pages API method.
    Blog / 20 March 2020
  • Subscribe to weekly ProcessWire news

“We chose ProcessWire because of its excellent architecture, modular extensibility and the internal API. The CMS offers the necessary flexibility and performance for such a complex website like superbude.de. ProcessWire offers options that are only available for larger systems, such as Drupal, and allows a much slimmer development process.” —xport communication GmbH