$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.148

Twitter updates

  • New post in the blog about all the fun we had driving around a DDOS attack on our forums, how we got it back under control, and what we learned along the way. Plus PW 3.0.150 dev details and links! More
    7 February 2020
  • New post: ProcessWire core updates (January 31, 2020)— More
    31 January 2020
  • Weekly update for Jan 10, 2020—front-end file uploads in LoginRegisterPro with InputfieldFrontendFile module: More
    10 January 2020

Latest news

  • ProcessWire Weekly #301
    In the 301st issue of ProcessWire Weekly we're going to check out the latest core updates, introduce brand new third party modules RockDaterange and Modules Manager 2, and highlight a brilliant new site of the week. Read on!
    Weekly.pw / 15 February 2020
  • Driving around a DDOS attack
    Last Saturday we started getting hit with heavy traffic at the processwire.com support forums, and it soon became a full blown DDOS frenzy. This post describes all the fun, how we got it back under control, and what we learned along the way.
    Blog / 7 February 2020
  • Subscribe to weekly ProcessWire news

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright—Marc Hinse, Web designer/developer