The RecordLinkHandler 

The RecordLinkHandler enables editors to link to single records, for example the detail page of a news record.

You can find examples here:

• Browse records of a table
• Link browser example in tutorial in the news extension manual

The handler is implemented in class \TYPO3\CMS\Backend\LinkHandler\RecordLinkHandler of the system extension backend. The class is marked as @internal and contains neither hooks nor events.

In order to use the RecordLinkHandler it can be configured as following:

1. Page TSconfig is used to create a new tab in the LinkBrowser to be able to select records.

   EXT:my_extension/Configuration/page.tsconfig (excerpt)

   TCEMAIN.linkHandler.anIdentifier {
     handler = TYPO3\CMS\Backend\LinkHandler\RecordLinkHandler
     label = extension.messages:link.customTab
     configuration {
       table = tx_myextension_domain_model_item
     }
     scanAfter = page
   }
   
   # ...
   

   Copied!

   You can position your own handlers in order as defined in the LinkBrowser API.

   The links are now stored in the database with the syntax <a href="t3://record?identifier=anIdentifier&amp;uid=456">A link</a> .

2. TypoScript configures how the link will be displayed in the frontend.

   EXT:my_extension/Configuration/Sets/Main/setup.typoscript (excerpt)

   config.recordLinks.anIdentifier {
     // Do not force link generation when the record is hidden
     forceLink = 0
     typolink {
       parameter = 123
       additionalParams.data = field:uid
       additionalParams.wrap = &tx_myextension_pi1[item]=|&tx_myextension_pi1[controller]=Item&tx_myextension_pi1[action]=show
     }
   }
   
   # ...
   

   Copied!

   Attention

   Do not change the identifier after links have been created using the RecordLinkHandler. The identifier will be stored as part of the link in the database.

TCEMAIN.linkHandler.anIdentifier {
  handler = TYPO3\CMS\Backend\LinkHandler\RecordLinkHandler
  label = extension.messages:link.customTab
  configuration {
    table = tx_myextension_domain_model_item
  }
}

# ...

config.recordLinks.anIdentifier {
  forceLink = 0

  typolink {
    parameter = 123
    additionalParams.data = field:uid
    additionalParams.wrap = &tx_myextension_pi1[item]=|
  }
}

# ...