caches()

Signature

caches() — returns void

Available in: controller Category: Configuration Functions

Description

Tells Wheels to cache one or more controller actions. Caching improves performance by storing the output of actions so that repeated requests do not require re-running the action logic.

Parameters

Name	Type	Required	Default	Description
action	string	no	—	Action(s) to cache. This argument is also aliased as actions.
time	numeric	no	60	Minutes to cache the action(s) for.
static	boolean	no	false	Set to true to tell Wheels that this is a static page and that it can skip running the controller filters (before and after filters set on actions). Please note that the onSessionStart and onRequestStart events still execute though.
appendToKey	string	no	—	List of variables to be evaluated at runtime and included in the cache key so that content can be cached separately.

Examples

1. Cache a single action (default 60 minutes)
caches("termsOfUse");

2. Cache multiple actions for 30 minutes
caches(actions="browseByUser, browseByTitle", time=30);

3. Cache actions as static pages, skipping filters
caches(actions="termsOfUse, codeOfConduct", static=true);

4. Cache content separately based on runtime variable
caches(action="home", appendToKey="request.region");