Miscellaneous
filters()
Signature
Section titled “Signature”filters() — returns any
Description
Section titled “Description”Tells CFWheels to run a function before an action is run or after an action has been run. You can also specify multiple functions and actions.
Parameters
Section titled “Parameters”| Name | Type | Required | Default | Description |
|---|---|---|---|---|
through | string | yes | — | Function(s) to execute before or after the action(s). |
type | string | yes | before | Whether to run the function(s) before or after the action(s). |
only | string | yes | — | Pass in a list of action names (or one action name) to tell CFWheels that the filter function(s) should only be run on these actions. |
except | string | yes | — | Pass in a list of action names (or one action name) to tell CFWheels that the filter function(s) should be run on all actions except the specified ones. |
placement | string | yes | append | Pass in prepend to prepend the function(s) to the filter chain instead of appending. |
Examples
Section titled “Examples”// Always execute `restrictAccess` before all actions in this controller
filters("restrictAccess");
// Always execute `isLoggedIn` and `checkIPAddress` (in that order) before all actions in this controller, except the `home` and `login` actions
filters(through="isLoggedIn,checkIPAddress", except="home,login");