Warning: You are browsing the documentation for PrestaShop 1.7, which is outdated.

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

Learn how to upgrade to the latest version.

LinkColumn Type

This LinkColumn displays a raw field data encapsulated in a link (very useful for adding an edition link on a name, for example).

Available options

Properties Type Expected value
field string required The record field name that the column displays.
route string required The route used to generate the link url.
route_param_name string required The parameter name used by the route to generate the url.
route_param_field string required The record field containing the route parameter.

Example usage

<?php
use PrestaShop\PrestaShop\Core\Grid\Column\Type\Common\LinkColumn;
use PrestaShop\PrestaShop\Core\Grid\Column\ColumnCollection;

$linkColumn = new LinkColumn('name_link');
$linkColumn->setName('Name');
$linkColumn->setOptions([
     'field' => 'name',
     'route' => 'admin_category_edit',
     'route_param_name' => 'categoryId',
     'route_param_field' => 'id_category',
]);

$columns = new ColumnCollection();
$columns->add($linkColumn);