Notice: You are browsing the documentation for PrestaShop 9, which is currently in development.

You might want to read the documentation for the current version, PrestaShop 8. Read the current version of this page

The Link component

The Link component generates URLs for various PrestaShop routes. It provides a simple mechanism to handle:

  • URL Rewriting (friendly URLs)
  • HTTP/HTTPS schemes
  • routing to entities, controllers, modules, …

Link is available through the Context, and provides several useful methods such as those documented methods below:

  • getProductLink()
  • getCategoryLink()
  • getModuleLink()
  • getPageLink()

and many more. To discover all available methods, you can explore the Link class.

While possible, it is discouraged to instantiate the Link class by yourself. Please use the Link provided by a Context.

To obtain the URL of a product, with the right HTTP scheme, and URL rewriting (if enabled), use:

// obtain $context from a controller or from a module with: 
$context = $this->context;

// or from anywhere else:
$context = Context::getContext();

// get your product instance (from ObjectModel in this example)
$product = new Product(123);

// get your product URL
$link = $context->link->getProductLink($product);

More parameters are available for this method, please refer to the method definition for details.

To obtain the URL of a category, with the right HTTP scheme, and URL rewriting (if enabled), use:

// get your category instance (from ObjectModel in this example)
$category = new Category(123);

// get your category URL
$link = $context->link->getCategoryLink($category);

More parameters are available for this method, please refer to the method definition for details.

To obtain the URL of a module controller, with the right HTTP scheme, and URL rewriting (if enabled), use :

// get your module's default controller URL
$link = $context->link->getModuleLink('mymodulename');

// get your module's specific controller URL
$link = $context->link->getModuleLink('mymodulename', 'controllerName');

// get your module's specific controller URL with params
$params = [
    'id_item' => 2,
    'action' => 'showTodo'
];
$link = $context->link->getModuleLink('mymodulename', 'controllerName', $params);

More parameters are available for this method, please refer to the method definition for details.

Use the Link component to get the URL of a page with getPageLink() method

To obtain the URL of a page controller, with the right HTTP scheme, and URL rewriting (if enabled), use:

// get the cart link
$link = $context->link->getPageLink('cart');

// get the cart link to delete the product with id=1 and product attribute=101;
$idProduct = 1;
$idProductAttribute = 101;

$params = [
    'delete' => 1,
    'id_product' => $idProduct,
    'id_product_attribute' => $idProductAttribute,
];

$link = $context->link->getPageLink('cart', true, null, $params,false);

More parameters are available for this method, please refer to the method definition for details.

You can also generate URLs for admin routes using Link, please read the dedicated page on this topic