typolink

Target used for external links

Target used for file links

Language uid for link target

Omitting the parameter language will use the current language.

page.10 = TEXT
page.10.value = Link to the page with the ID 23 in the current language
page.10.typolink.parameter = 23

page.20 = TEXT
page.20.value = Link to the page with the ID 23 in the language 3
page.20.typolink.parameter = 23
page.20.typolink.language = 3

Target used for internal links

Adds &no_cache=1 to the link

This is parameters that are added to the end of the URL. This must be code ready to insert after the last parameter.

page.10.typolink.additionalParams = '&print=1'
page.20.typolink.additionalParams = '&sword_list[]=word1&sword_list[]=word2'

This is very useful – for example – when linking to pages from a search result. The search words are stored in the register-key SWORD_PARAMS and can be insert directly like this:

page.20.typolink.additionalParams.data = register:SWORD_PARAMS

Add the current query string to the start of the link.

Possible values:

0

No query parameters are added.

1

Only query parameters resolved by route enhancers are added, any other query arguments are rejected. This way, additional query arguments are never added by default. This is the recommended behaviour.

untrusted

Any given query parameters of the current request are added.

# Pass resolved query parameters to the link
typolink.addQueryString = 1

# Pass all query parameters to the link
typolink.addQueryString = untrusted

Wraps the links.

If set, the link is first wrapped with wrap and then the <A>-tag.

This is the main data that is used for creating the link. It can be the id of a page, the URL of some external page, an email address or a reference to a file on the server. On top of this there can be additional information for specifying a target, a class and a title. Below are a few examples followed by full explanations.

1. Most simple. Will create a link to page 51 (if this is not default language, the correct target language will be resolved from the parameter):

   EXT:site_package/Configuration/TypoScript/setup.typoscript

   page.10.typolink.parameter = t3://page?uid=51

   Copied!

2. A full example. A link to the current page that will open in a new window. The link will have a class attribute with value "specialLink" and a title attribute reading "Very important information":

   EXT:site_package/Configuration/TypoScript/setup.typoscript

   page.10.typolink.parameter = t3://page?uid=current _blank specialLink "Very important information"

   Copied!

   which is converted to a link like this:

   Example output

   <a href="?id=51" target="_blank" class="specialLink" title="Very important information">

   Copied!

3. An external link with a class attribute. Note the dash (-) that replaces the second value (the target). This makes it possible to define a class (third value) without having to define a target:

   EXT:site_package/Configuration/TypoScript/setup.typoscript

   page.10.typolink.parameter = https://example.com/ - specialLink

   Copied!

4. A mailto link with a title attribute (but no target and no class):

   EXT:site_package/Configuration/TypoScript/setup.typoscript

   page.10.typolink.parameter = mailto:info@example.org - - "Send a mail to main TYPO3 contact"

   Copied!

As you can see from the examples, each significant part of the parameter string is separated by a space. Values that can themselves contain spaces must be enclosed in double quotes. Each of these values are described in more detail below.

Link targets that are external or contain _blank will be added rel="noreferrer" automatically.

1. The link

   The first value is the destination of the link. It may start with:

   • t3://: internal TYPO3 resource references. See Resource references for an in depth explanation on the syntax of these references.
   • http(s)://: regular external links
   • mailto:info@example.org: regular mailto links

   It's also possible to direct the typolink to use a custom function (a "link handler") to build the link. This is described in more detail below.

2. Target or popup settings

   Targets are normally as described above (extTarget, fileTarget, target). But it is possible to override them by explicitly defining a target in the parameter property. It's possible to use a dash (-) to skip this value when one wants to define a third or fourth value, but no target.

   Instead of a target, this second value can be used to define the parameters of a JavaScript popup window into which the link will be opened (using window.open). The height and width of the window can be defined, as well as additional parameters to be passed to the JavaScript function. Also see property "Jswindow".

   Examples

   Open page 51 in a popup window measuring 400 by 300 pixels:

   EXT:site_package/Configuration/TypoScript/setup.typoscript

   typolink.parameter = 51 400x300

   Copied!

   Open page 51 in a popup window measuring 400 by 300 pixels. Do not make the window resizable and show the location bar:

   EXT:site_package/Configuration/TypoScript/setup.typoscript

   typolink.parameter = 51 400x300:resizable=0,location=1

   Copied!

3. Class

   The third value can be used to define a class name for the link tag. This class is inserted in the tag before any other value from the "ATagParams" property. Beware of conflicting class attributes. It's possible to use a dash (-) to skip this value when one wants to define a fourth value, but no class (see examples above).

4. Title

   The standard way of defining the title attribute of the link would be to use the title property or even the ATagParams property. However it can also be set in this fourth value, in which case it will override the other settings. Note that the title should be wrapped in double quotes (") if it contains blanks.

   Attention

   When used from parseFunc, the value should not be defined explicitly, but imported like this:

   EXT:site_package/Configuration/TypoScript/setup.typoscript

   typolink.parameter.data = parameters : allParams

   Copied!

Forces links to internal pages to be absolute, thus having a proper URL scheme and domain prepended.

Additional sub-property: forceAbsoluteUrl.scheme

Sets the title parameter of the A-tag.

Preset values for opening the window. This example lists almost all possible attributes:

page.10.typolink.JSwindow_params = status=1,menubar=1,scrollbars=1,resizable=1,location=1,directories=1,toolbar=1

If set to "url", then it will return the URL of the link ($this->lastTypoLinkUrl).

If set to target, it will return the target of the link.

So, in these two cases you will not get the value wrapped but the URL or target value returned!

If set to result, it will return the json_encoded output of the internal LinkResult object.

{
    "href": "/my-page",
    "target": null,
    "class": null,
    "title": null,
    "linkText": "My page",
    "additionalAttributes": []
}

If this value is present, it's prepended with a "#" and placed after any internal URL to another page in TYPO3.

This is used create a link, which jumps from one page directly the section on another page.

Additional parameters

page.10.typolink.ATagParams = class="board"

If set, typolinks pointing to access restricted pages will still link to the page even though the page cannot be accessed.

All of the typolink TypoScript configuration will be parsed and evaluated by the TYPO3 Core's LinkFactory->create() method, and then passed on to the defined userFunc for further manipulation. The userFunc needs to return an object implementing the LinkResultInterface. The currently calculated typolink is passed as an argument to the userFunc as an object of the same type. This allows to return either an enriched link, or a completely new one.

The detailed execution steps are:

First, the typolink will be created as configured by the specified TypoScript. This will result in an object of Type LinkResultInterface. This immutable object receives all of the TypoScript typolink configuration as properties, and makes them available via corresponding getters. Then your custom userFunc is executed and receives the following arguments (delivered via $contentObjectRenderer->callUserFunction()):

$content

This contains the object implementing LinkResultInterface. Inside your userFunc() you can call for example:

• $content->getUrl() to get the URL of a link,
• $content->getLinkText() to get the text of your link (everything with the <a>...</a> tag),
• $content->getLinkConfiguration() for the array with all typolink configuration options,
• $content->getAttributes() returns current anchor link attributes (like typolink.additionalArguments),
• $content->getType() returns the kind of link that is operated on, like LinkService::TYPE_PAGE (specific pages in your TYPO3 setup) or LinkService::TYPE_URL for links to external pages.

See the PHP definition of LinkResultInterface for the full list of getters.

Since LinkResultInterface is an immutable object, you must use the methods withLinkText() and/or withAttributes() to create a new object variant, which at the end of your userFunc must be returned (see below for examples). In case you do not make any changes to the object, the function must return the original object.

$conf

Contains an array of the TypoScript configuration of your userFunc parameters.

$request

Contains the PSR-7 request object that allows you to operate on your current frontend environment and retrieve things like Site Settings, current Language, current URL, related ContentObjectRenderer ($cObj) and other aspects, see TYPO3 request object.

See Examples for typolink.userFunc for more details.

The page identifier is a compound string based on several optional settings.

Links to a file to download.

Links to a folder.

Mail address to be used, prefixed with mailto:

URL to be used, if no scheme is used $GLOBALS['TYPO3_CONF_VARS']['SYS']['defaultScheme'] is prefixed automatically. The schemes javascript: and data: are forbidden for security reasons and result in an empty url.

Query parameters have to be URL-encoded.

Examples:

• t3://url?url=example.org
• t3://url?url=https://example.org
• t3://url?url=https://example.org%26parameter=value

Can be used to link to a record of a certain table. See also the Record link tutorial in TYPO3 Explained.

Parameters record.identifier and record.uid are mandatory for this link handler.

This link handler sets links to phone numbers using the tel: protocol.