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

Twitter updates

  • ProcessWire 3.0.180 core updates– More
    18 June 2021
  • Today a new version of FormBuilder has been released in the FormBuilder support board (our 50th version) and it has a lot of interesting new features, which we’ll take a closer look at in this post— More
    11 June 2021
  • ProcessWire 3.0.179 adds great new admin theme customization tools that put you in full control over the Uikit admin styles— More
    28 May 2021

Latest news

  • ProcessWire Weekly #371
    In the 371st issue of ProcessWire Weekly we'll check out ProcessWire 3.0.180, introduce a new module called Flowti Page Serializer, highlight some recent forum posts and tutorials, and more. Read on!
    Weekly.pw / 19 June 2021
  • ProcessWire FormBuilder v50 updates
    Today a new version of FormBuilder has been released in the FormBuilder support board (our 50th version) and it has a lot of interesting new features, which we'll take a closer look at in this post.
    Blog / 11 June 2021
  • Subscribe to weekly ProcessWire news

“…building with ProcessWire was a breeze, I really love all the flexibility the system provides. I can’t imagine using any other CMS in the future.” —Thomas Aull