Attention
TYPO3 v11 has reached end-of-life as of October 31th 2024 and is no longer being maintained. Use the version switcher on the top left of this page to select documentation for a supported version of TYPO3.
Need more time before upgrading? You can purchase Extended Long Term Support (ELTS) for TYPO3 v11 here: TYPO3 ELTS.
Link.page ViewHelper <f:link.page>
A ViewHelper for creating links to TYPO3 pages.
Examples
Link to the current page
<f:link.page>page link</f:link.page>
Output:
<a href="/page/path/name.html">page link</a>
Depending on current page, routing and page path configuration.
Query parameters
<f:link.page pageUid="1" additionalParams="{foo: 'bar'}">page link</f:link.page>
Output:
<a href="/page/path/name.html?foo=bar">page link</a>
Depending on current page, routing and page path configuration.
Query parameters for extensions
<f:link.page pageUid="1" additionalParams="{extension_key: {foo: 'bar'}}">page link</f:link.page>
Output:
<a href="/page/path/name.html?extension_key[foo]=bar">page link</a>
Depending on current page, routing and page path configuration.
Source code
Go to the source code of this ViewHelper: PageViewHelper.php (GitHub).
Arguments
The following arguments are available for <f:
:
additionalAttributes
-
- Type
- mixed
Additional tag attributes. They will be added directly to the resulting HTML tag.
data
-
- Type
- mixed
Additional data-* attributes. They will each be added with a "data-" prefix.
aria
-
- Type
- mixed
Additional aria-* attributes. They will each be added with a "aria-" prefix.
class
-
- Type
- string
CSS class(es) for this element
dir
-
- Type
- string
Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left)
id
-
- Type
- string
Unique (in this file) identifier for this HTML element.
lang
-
- Type
- string
Language for this element. Use short names specified in RFC 1766
style
-
- Type
- string
Individual CSS styles for this element
title
-
- Type
- string
Tooltip text of element
accesskey
-
- Type
- string
Keyboard shortcut to access this element
tabindex
-
- Type
- integer
Specifies the tab order of this element
onclick
-
- Type
- string
JavaScript evaluated for the onclick event
target
-
- Type
- string
Target of link
rel
-
- Type
- string
Specifies the relationship between the current document and the linked document
pageUid
-
- Type
- mixed
Target page. See TypoLink destination
pageType
-
- Type
- mixed
Type of the target page. See typolink.parameter
noCache
-
- Type
- boolean
Set this to disable caching for the target page. You should not need this.
language
-
- Type
- string
Link to a specific language - defaults to the current language, use a language ID or "current" to enforce a specific language
section
-
- Type
- string
The anchor to be added to the URI
linkAccessRestrictedPages
-
- Type
- boolean
If set, links pointing to access restricted pages will still link to the page even though the page cannot be accessed.
additionalParams
-
- Type
- mixed
Additional query parameters that won't be prefixed like $arguments (overrule $arguments)
absolute
-
- Type
- boolean
If set, the URI of the rendered link is absolute
addQueryString
-
- Type
- boolean
If set, the current query parameters will be kept in the URI
argumentsToBeExcludedFromQueryString
-
- Type
- mixed
Arguments to be removed from the URI. Only active if $addQueryString = TRUE
addQueryStringMethod
-
- Type
- string
This argument is not evaluated anymore and will be removed in TYPO3 v12.