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
| Name | Type(s) | Description |
|---|---|---|
fieldName | string | 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 stringReturns 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 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 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 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
API reference based on ProcessWire core version 3.0.214