XenForo Reference Guide for Developer
Back to top  

Interface for a route that can build a link to a specified type of data.

package XenForo_Mvc

 Methods

Method to build a link to the specified page/action with the provided data and params.

buildLink(string $originalPrefix, string $outputPrefix, string $action, string $extension, mixed $data, array $extraParams) : string | false

Unhandled extra params will be turned into a query string after this function is called. If a param is handled by the core URL, it should be unset from the extra params list.

Parameters

$originalPrefix

string

Original prefix for the type of link to be generated; this is a known value, but shouldn't be displayed to the user

$outputPrefix

string

The configured output that means the same thing as the original prefix but is user configured

$action

string

Action to take on the data

$extension

string

Specified extension for the link

$data

mixed

Info about data to link to specifically (eg, info about a thread)

$extraParams

array

Extra params that modify how the link is built

Returns

stringfalseCore link if handled, false otherwise