page.link ViewHelper `<vhs:page.link>`¶

Page: Link ViewHelper¶

Viewhelper for rendering page links

This viewhelper behaves identically to Fluid's link viewhelper except for it fetches the title of the provided page UID and inserts it as linktext if that is omitted. The link will not render at all if the requested page is not translated in the current language.

Automatic linktext: <v:page.link pageUid="UID" />
Manual linktext:    <v:page.link pageUid="UID">linktext</v:page.link>

Arguments¶

additionalAttributes¶

DataType: mixed
Required: false
Description: Additional tag attributes. They will be added directly to the resulting HTML tag.

data¶

DataType: mixed
Required: false
Description: Additional data-* attributes. They will each be added with a "data-" prefix.

aria¶

DataType: mixed
Required: false
Description: Additional aria-* attributes. They will each be added with a "aria-" prefix.

class¶

DataType: string
Required: false
Description: CSS class(es) for this element

dir¶

DataType: string
Required: false
Description: Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left)

id¶

DataType: string
Required: false
Description: Unique (in this file) identifier for this HTML element.

lang¶

DataType: string
Required: false
Description: Language for this element. Use short names specified in RFC 1766

style¶

DataType: string
Required: false
Description: Individual CSS styles for this element

title¶

DataType: string
Required: false
Description: Tooltip text of element

accesskey¶

DataType: string
Required: false
Description: Keyboard shortcut to access this element

tabindex¶

DataType: integer
Required: false
Description: Specifies the tab order of this element

onclick¶

DataType: string
Required: false
Description: JavaScript evaluated for the onclick event

showAccessProtected¶

DataType: boolean
Required: false
Description: If TRUE links to access protected pages are always rendered regardless of user login status

classAccessProtected¶

DataType: string
Default: 'protected'
Required: false
Description: Optional class name to add to links which are access protected

classAccessGranted¶

DataType: string
Default: 'access-granted'
Required: false
Description: Optional class name to add to links which are access protected but access is actually granted

useShortcutUid¶

DataType: boolean
Required: false
Description: If TRUE, substitutes the link UID of a shortcut with the target page UID (and thus avoiding redirects) but does not change other data - which is done by using useShortcutData.

useShortcutTarget¶

DataType: boolean
Required: false
Description: Optional param for using shortcut target instead of shortcut itself for current link

useShortcutData¶

DataType: boolean
Required: false
Description: Shortcut to set useShortcutTarget and useShortcutData simultaneously

target¶

DataType: string
Required: false
Description: Target of link

rel¶

DataType: string
Required: false
Description: Specifies the relationship between the current document and the linked document

pageUid¶

DataType: integer
Required: false
Description: UID of the page to create the link and fetch the title for.

additionalParams¶

DataType: mixed
Default: array ()
Required: false
Description: Query parameters to be attached to the resulting URI

pageType¶

DataType: integer
Required: false
Description: Type of the target page. See typolink.parameter

noCache¶

DataType: boolean
Required: false
Description: When TRUE disables caching for the target page. You should not need this.

noCacheHash¶

DataType: boolean
Required: false
Description: When TRUE supresses the cHash query parameter created by TypoLink. You should not need this. Has no effect on TYPO3v11 and above.

section¶

DataType: string
Required: false
Description: The anchor to be added to the URI

absolute¶

DataType: boolean
Required: false
Description: When TRUE, the URI of the rendered link is absolute

addQueryString¶

DataType: boolean
Required: false
Description: When TRUE, the current query parameters will be kept in the URI

argumentsToBeExcludedFromQueryString¶

DataType: mixed
Default: array ()
Required: false
Description: Arguments to be removed from the URI. Only active if $addQueryString = TRUE

titleFields¶

DataType: string
Default: 'nav_title,title'
Required: false
Description: CSV list of fields to use as link label - default is "nav_title,title", change to for example "tx_myext_somefield,subtitle,nav_title,title". The first field that contains text will be used. Field value resolved AFTER page field overlays.

pageTitleAs¶

DataType: string
Required: false
Description: When rendering child content, supplies page title as variable.

page.link ViewHelper <vhs:page.link>¶