URLFor()
Description
Creates an internal URL based on supplied arguments.
Function Syntax
URLFor([ route, controller, action, key, params, anchor, onlyPath, host, protocol, port ])
Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
route |
string |
No | |
Name of a route that you have configured in config/routes.cfm. |
controller |
string |
No | |
Name of the controller to include in the URL. |
action |
string |
No | |
Name of the action to include in the URL. |
key |
any |
No | |
Key(s) to include in the URL. |
params |
string |
No | |
Any additional params to be set in the query string. |
anchor |
string |
No | |
Sets an anchor name to be appended to the path. |
onlyPath |
boolean |
No | true |
If true, returns only the relative URL (no protocol, host name or port). |
host |
string |
No | |
Set this to override the current host. |
protocol |
string |
No | |
Set this to override the current protocol. |
port |
numeric |
No | 0 |
Set this to override the current port number. |
Examples
<!--- Create the URL for the `logOut` action on the `account` controller, typically resulting in `/account/logout` --->
#URLFor(controller="account", action="logOut")#
<!--- Create a URL with an anchor set on it --->
#URLFor(action="comments", anchor="comment10")#
