$page->renderValue() method

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

See the documentation for the Page::renderField() method for information about the $file argument.

Example

// Render a value using site/templates/fields/my-images.php custom output template
$images = $page->images;
echo $page->renderValue($images, 'my-images');

Usage

// basic usage
$mixed = $page->renderValue(mixed $value);

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

Arguments

Name	Type(s)	Description
`value`	mixed	Value to render
`file` (optional)	string	Optionally specify file (in site/templates/fields/) to render with (may omit .php extension)

Return value

mixed string

Returns rendered value

Hooking $page->renderValue(…)

You can add your own hook events that are executed either before or after the $page->renderValue(…) 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->renderValue(…) method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

$this->addHookBefore('Page::renderValue', 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)
  $value = $event->arguments(0);
  $file = $event->arguments(1);

  /* Your code here, perhaps modifying arguments */

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

Hooking after

The 'after' hooks are called immediately after each $page->renderValue(…) 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::renderValue', 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)
  $value = $event->arguments(0);
  $file = $event->arguments(1);

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

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

$page methods and properties

API reference based on ProcessWire core version 3.0.236