renderView()

Signature

renderView() — returns any

Available in: controller Category: Rendering Functions

Description

Instructs the controller which view template and layout to render when it’s finished processing the action. Note that when passing values for controller and / or action, this function does not execute the actual action but rather just loads the corresponding view template.

Parameters

Name	Type	Required	Default	Description
controller	string	no	[runtime expression]	Controller to include the view page for.
action	string	no	[runtime expression]	Action to include the view page for.
template	string	no	—	A specific template to render. Prefix with a leading slash (/) if you need to build a path from the root views folder.
layout	any	no	—	The layout to wrap the content in. Prefix with a leading slash (/) if you need to build a path from the root views folder. Pass false to not load a layout at all.
cache	any	no	—	Number of minutes to cache the content for.
returnAs	string	no	—	Set to string to return the result instead of automatically sending it to the client.
hideDebugInformation	boolean	no	false	Set to true to hide the debug information at the end of the output. This is useful, for example, when you’re testing XML output in an environment where the global setting for showDebugInformation is true.
status	string	no	[runtime expression]	Force request to return with specific HTTP status code.

Examples

// 1. Render the view template for a different action within the same controller.
renderView(action="edit");

// 2. Render the view template for a different action within a different controller.
renderView(controller="blog", action="new");

// 3. Render a specific template using an absolute path from the `views` folder.
renderView(template="/blog/new");

// 4. Render without a layout and cache the output for 60 minutes.
renderView(layout=false, cache=60);

// 5. Load a layout from a non-default folder within `views`.
renderView(layout="/layouts/blog");

// 6. Return the rendered output as a string instead of sending it to the client.
myView = renderView(returnAs="string");

// 7. Render with a specific HTTP status code (useful for error pages).
renderView(action="notFound", status=404);

// 8. Render XML output and suppress debug information even when `showDebugInformation` is globally enabled.
renderView(template="/reports/summary", layout=false, hideDebugInformation=true);