View Helpers Link Functions string controller
Creates a link to another page in your application. Pass in the name of a route to use your configured routes or a controller/action/key combination. Note: Pass any additional arguments like class, rel, and id, and the generated tag will also include those values as HTML attributes.
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| text | string | No | The text content of the link. | |
| 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 parameters to be set in the query string (example: wheels=cool&x=y). Please note that CFWheels uses the & and = characters to split the parameters and encode them properly for you. However, if you need to pass in & or = as part of the value, then you need to encode them (and only them), example: a=cats%26dogs%3Dtrouble!&b=1. | |
| 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. |
| href | string | No | Pass a link to an external site here if you want to bypass the CFWheels routing system altogether and link to an external URL. | |
| encode | any | No | true | Use this argument to decide whether the output of the function should be encoded in order to prevent Cross Site Scripting (XSS) attacks. Set it to true to encode all relevant output for the specific HTML element in question (e.g. tag content, attribute values, and URLs). For HTML elements that have both tag content and attribute values you can set this argument to attributes to only encode attribute values and not tag content. |
#linkTo(text="Log Out", controller="account", action="logout")#
<!--- Ouputs: <a href="/account/logout">Log Out</a> --->
<!--- If you're already in the `account` controller, CFWheels will assume that's where you want the link to point --->
#linkTo(text="Log Out", action="logout")#
<!--- Ouputs: <a href="/account/logout">Log Out</a> --->
#linkTo(text="View Post", controller="blog", action="post", key=99)#
<!--- Ouputs: <a href="/blog/post/99">View Post</a> --->
#linkTo(text="View Settings", action="settings", params="show=all&sort=asc")#
<!--- Ouputs: <a href="/account/settings?show=all&amp;sort=asc">View Settings</a> --->
<!--- Given that a `userProfile` route has been configured in `config/routes.cfm` --->
#linkTo(text="Joe's Profile", route="userProfile", userName="joe")#
<!--- Ouputs: <a href="/user/joe">Joe's Profile</a> --->
<!--- Link to an external website --->
#linkTo(text="ColdFusion Framework", href="http://cfwheels.org/")#
<!--- Ouputs: <a href="http://cfwheels.org/">ColdFusion Framework</a> --->
<!--- Give the link `class` and `id` attributes --->
#linkTo(text="Delete Post", action="delete", key=99, class="delete", id="delete-99")#
<!--- Ouputs: <a class="delete" href="/blog/delete/99" id="delete-99">Delete Post</a> --->