$page->renderField() method

Render given $fieldName using site/templates/fields/ markup file

Shorter aliases of this method include:

  • $page->render('fieldName', $file);
  • $page->render->fieldName;
  • $page->_fieldName_;

This method expects that there is a file in /site/templates/fields/ to render the field with:

  • /site/templates/fields/fieldName.php
  • /site/templates/fields/fieldName.templateName.php
  • /site/templates/fields/fieldName/$file.php (using $file argument)
  • /site/templates/fields/$file.php (using $file argument)
  • /site/templates/fields/$file/fieldName.php (using $file argument, must have trailing slash)
  • /site/templates/fields/$file.fieldName.php (using $file argument, must have trailing period)

Note that the examples above showing $file require that the $file argument is specified.

Example

// Render output for the 'images' field (assumes you have implemented an output file)
echo $page->renderField('images');

Usage

// basic usage
$mixed = $page->renderField(string $fieldName);

// usage with all arguments
$mixed = $page->renderField(string $fieldName, string $file = '', $value = null);

Arguments

NameType(s)Description
fieldNamestring

May be any custom field name or native page property.

file (optional)string

Optionally specify file (in site/templates/fields/) to render with (may omit .php extension).

value (optional)mixed, null

Optionally specify value to render, otherwise it will be pulled from this $page.

Return value

mixed string

Returns the rendered value of the field


Hooking $page->renderField(…)

You can add your own hook events that are executed either before or after the $page->renderField(…) method is executed. Examples of both are included below. A good place for hook code such as this is in your /site/ready.php file.

Hooking before

The 'before' hooks are called immediately before each $page->renderField(…) method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

$this->addHookBefore('Page::renderField', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $page = $event->object;

  // Get values of arguments sent to hook (and optionally modify them)
  $fieldName = $event->arguments(0);
  $file = $event->arguments(1);
  $value = $event->arguments(2);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $fieldName);
  $event->arguments(1, $file);
  $event->arguments(2, $value);
});

Hooking after

The 'after' hooks are called immediately after each $page->renderField(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('Page::renderField', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $page = $event->object;

  // An 'after' hook can retrieve and/or modify the return value
  $return = $event->return;

  // Get values of arguments sent to hook (if needed)
  $fieldName = $event->arguments(0);
  $file = $event->arguments(1);
  $value = $event->arguments(2);

  /* Your code here, perhaps modifying the return value */

  // Populate back return value, if you have modified it
  $event->return = $return;
});

See Also


$page methods and properties

API reference based on ProcessWire core version 3.0.161

Twitter updates

  • New ProcessWire query expansion search operators can now add automatic word inflections and lemmatisation, enabling you to build even smarter search engines with ProcessWire. More
    3 July 2020
  • ProcessWire 3.0.161 adds support for selector operator stacking, enabling you automatically broaden searches in a single pages.find() call— More
    26 June 2020
  • ProcessWire 3.0.160 adds powerful new text-searching operators, bringing a new level of power to page-finding API calls, especially when it comes to search engine type queries. Post also includes a demo search engine where you can test it all out live— More
    19 June 2020

Latest news

  • ProcessWire Weekly #321
    In the 321st issue of ProcessWire Weekly we're going to check out the latest core updates, introduce two new third party modules, and check out a brand new site of the week. Read on!
    Weekly.pw / 4 July 2020
  • Powerful new text-searching abilities in 3.0.160
    In ProcessWire 3.0.160 we’ve got some major upgrades and additions to our text-search abilities. This brings a whole new level of power to $pages->find() and similar API calls, especially when it comes to search engine type queries.
    Blog / 19 June 2020
  • 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