$this->tabs = [\n [\n 'route_name' => 'demo_tab_one',\n 'class_name' => DemoTabOneController::TAB_CLASS_NAME,\n 'visible' => true,\n 'name' => $tabNames,\n 'icon' => 'settings',\n 'parent_class_name' => 'IMPROVE',\n ]\n];<\/pre>\n\n\n\nWhere:<\/strong>
class_name<\/strong>: Class is called when the user will click on your link. This is the class name without the Controller part.
route_name<\/strong>: Symfony route name, if your controller is Symfony-based (Since PrestaShop v1.7.7)
name<\/strong>: Label displayed in the menu. If not provided, the class name is shown instead.
parent_class_name<\/strong>: The parent menu, if you want to display it in a subcategory.
icon<\/strong>: Icon name to use if any
visible<\/strong>: Whether you want to display the tab or not. Hidden tabs are used when you don\u2019t need a menu item but you still need to handle access rights.<\/p>\n\n\n\nYou can get more information about these parameters on the PrestaShop developer documentation<\/a>.<\/p>\n\n\n\n
We can also register the tabs manually at the time of module installation:<\/p>\n\n\n\n
private function manuallyInstallTab()\n{\n $tab = new Tab();\n $tab->active = 1;\n $tab->class_name = DemoTabTwoController::TAB_CLASS_NAME;\n \/\/ Only since 1.7.7, you can define a route name\n $tab->route_name = 'demo_tab_two';\n $tab->name = [];\n foreach (Language::getLanguages() as $lang) {\n $tab->name[$lang['id_lang']] = $this->trans('Demo tab two', [], 'Modules.Wkadmintabs.Admin', $lang['locale']);\n }\n $tab->icon = 'build';\n $tab->id_parent = (int) Tab::getIdFromClassName('IMPROVE');\n $tab->module = $this->name;\n\n return $tab->save();\n}<\/pre>\n\n\n\nSo, let’s create a simple module “wkadmintabs”. Module file and folder structure will be like:<\/p>\n\n\n\n
+---config\n| |- routes.yml\n|\n+---src\n| \\---controller\n| \\---Admin\n| |- DemoTabOneController.php\n| |- DemoTabTwoController.php\n|\n+---vendor (generated by composer.json)\n|\n\\---views\n| \\---templates\n| \\---admin\n| |- demotabone.html.twig\n| |- demotabtwo.html.twig\n|\n|- composer.json\n|- wkadmintabs.php<\/pre>\n\n\n\nAdd the main file ‘wkadmintabs.php’ of this module:<\/p>\n\n\n\n
<?php\n\nif (!defined('_PS_VERSION_')) {\n exit;\n}\n\nuse Language;\nuse PrestaShop\\Module\\Wkadmintabs\\Controller\\Admin\\DemoTabOneController;\nuse PrestaShop\\Module\\Wkadmintabs\\Controller\\Admin\\DemoTabTwoController;\n\nrequire_once __DIR__ . '\/vendor\/autoload.php';\n\nclass Wkadmintabs extends Module\n{\n public function __construct()\n {\n $this->name = 'wkadmintabs';\n $this->author = 'Webkul';\n $this->version = '1.0.0';\n $this->ps_versions_compliancy = ['min' => '1.7.7', 'max' => _PS_VERSION_];\n\n parent::__construct();\n\n $this->displayName = $this->l('Admin Controller Tabs');\n $this->description = $this->l('Create Tabs in Symfony Controller and manage its Permissions');\n\n \/\/ See https:\/\/devdocs.prestashop.com\/1.7\/modules\/concepts\/controllers\/admin-controllers\/tabs\/\n $tabNames = [];\n foreach (Language::getLanguages(true) as $lang) {\n $tabNames[$lang['locale']] = $this->trans('Demo tab one', [], 'Modules.Wkadmintabs.Admin', $lang['locale']);\n }\n $this->tabs = [\n [\n 'route_name' => 'demo_tab_one',\n 'class_name' => DemoTabOneController::TAB_CLASS_NAME,\n 'visible' => true,\n 'name' => $tabNames,\n 'icon' => 'settings',\n 'parent_class_name' => 'IMPROVE',\n ]\n ];\n }\n\n public function install()\n {\n return parent::install() && $this->manuallyInstallTab();\n }\n\n \/**\n * @return bool\n *\/\n private function manuallyInstallTab()\n {\n $tab = new Tab();\n $tab->active = 1;\n $tab->class_name = DemoTabTwoController::TAB_CLASS_NAME;\n \/\/ Only since 1.7.7, you can define a route name\n $tab->route_name = 'demo_tab_two';\n $tab->name = [];\n foreach (Language::getLanguages() as $lang) {\n $tab->name[$lang['id_lang']] = $this->trans('Demo tab two', [], 'Modules.Wkadmintabs.Admin', $lang['locale']);\n }\n $tab->icon = 'build';\n $tab->id_parent = (int) Tab::getIdFromClassName('IMPROVE');\n $tab->module = $this->name;\n\n return $tab->save();\n }\n}<\/pre>\n\n\n\nCreate ‘DemoTabOneController.php’ and ‘DemoTabTwoController.php’ controller files under the “Controller\\Admin” folder:<\/p>\n\n\n\n
<?php\nnamespace PrestaShop\\Module\\Wkadmintabs\\Controller\\Admin;\n\nuse PrestaShopBundle\\Controller\\Admin\\FrameworkBundleAdminController;\nuse Symfony\\Component\\HttpFoundation\\Response;\n\nclass DemoTabOneController extends FrameworkBundleAdminController\n{\n const TAB_CLASS_NAME = 'WkAdminTabsControllerTabsOne';\n\n \/**\n * @return Response\n *\/\n public function indexAction()\n {\n return $this->render('@Modules\/wkadmintabs\/views\/templates\/admin\/demotabone.html.twig');\n }\n}<\/pre>\n\n\n\n<?php\nnamespace PrestaShop\\Module\\Wkadmintabs\\Controller\\Admin;\n\nuse PrestaShopBundle\\Controller\\Admin\\FrameworkBundleAdminController;\nuse Symfony\\Component\\HttpFoundation\\Response;\n\nclass DemoTabTwoController extends FrameworkBundleAdminController\n{\n const TAB_CLASS_NAME = 'WkAdminTabsControllerTabsTwo';\n\n \/**\n * @return Response\n *\/\n public function indexAction()\n {\n return $this->render('@Modules\/wkadmintabs\/views\/templates\/admin\/demotabtwo.html.twig');\n }\n}<\/pre>\n\n\n\nCreate ‘demotabone.html.twig’ and ‘demotabtwo.html.twig’ view files for both controllers under the “views\/templates\/admin” folder:<\/p>\n\n\n\n
{% extends "PrestaShopBundle:Admin:layout.html.twig" %}\n{% block content %}\n <h2>This is tab one content.<\/h2>\n{% endblock %}<\/pre>\n\n\n\n{% extends "PrestaShopBundle:Admin:layout.html.twig" %}\n{% block content %}\n <h2>This is tab two content.<\/h2>\n{% endblock %}<\/pre>\n\n\n\nAdd ‘composer.json’ file and add the module information:<\/p>\n\n\n\n
{\n "description": "Create Tabs in Symfony Controller and manage its Permissions",\n "autoload": {\n "psr-4": {\n "PrestaShop\\\\Module\\\\Wkadmintabs\\\\": "src\/"\n }\n },\n "config": {\n "prepend-autoloader": false\n },\n "type": "prestashop-module"\n}<\/pre>\n\n\n\nAdd ‘route.yml’ file to define the routes:<\/p>\n\n\n\n
demo_tab_one:\n path: wkadmin-tabs\/demotabone\n methods: [GET]\n defaults:\n _controller: 'PrestaShop\\Module\\Wkadmintabs\\Controller\\Admin\\DemoTabOneController::indexAction'\n\ndemo_tab_two:\n path: wkadmin-tabs\/demotabtwo\n methods: [GET]\n defaults:\n _controller: 'PrestaShop\\Module\\Wkadmintabs\\Controller\\Admin\\DemoTabTwoController::indexAction'<\/pre>\n\n\n\nOnce you install this module in the PrestaShop, two new menu links are available in the back office:<\/p>\n\n\n\n
Admin Side Menu<\/figcaption><\/figure><\/div>\n\n\n\n Tab permissions, accesses and roles<\/h2>\n\n\n\n
At the time of the module installation, it automatically creates the appropriate roles in the ‘Tab::initAccess’ based on the class_name. For example, we are using ‘WkAdminTabsControllerTabsOne’ and ‘WkAdminTabsControllerTabsTwo’ as the class name then it will create the following roles in the PrestaShop:<\/p>\n\n\n\n
Tab Permissions & Roles<\/figcaption><\/figure><\/div>\n\n\n\n These roles will allow you to manage detailed permission in your controllers.<\/p>\n\n\n\n
We can provide access permission for every method used in the admin controller. Here is an example with a Symfony controller (WkAdminTabsControllerTabsOne). <\/p>\n\n\n\n
Nothing specific in this controller but notice the security annotation ‘@AdminSecurity’ that uses ‘request.get(‘_legacy_controller’)’ which will make the link between this controller and the routing configuration.<\/p>\n\n\n\n
<?php\nnamespace PrestaShop\\Module\\Wkadmintabs\\Controller\\Admin;\n\nuse PrestaShopBundle\\Controller\\Admin\\FrameworkBundleAdminController;\n<strong>use PrestaShopBundle\\Security\\Annotation\\AdminSecurity;<\/strong>\nuse Symfony\\Component\\HttpFoundation\\Response;\n\nclass DemoTabOneController extends FrameworkBundleAdminController\n{\n const TAB_CLASS_NAME = 'WkAdminTabsControllerTabsOne';\n\n \/**\n * <strong>@AdminSecurity("is_granted('read', request.get('_legacy_controller'))")<\/strong>\n *\n * @return Response\n *\/\n public function indexAction()\n {\n return $this->render('@Modules\/wkadmintabs\/views\/templates\/admin\/demotabone.html.twig');\n }\n}<\/pre>\n\n\n\nSo, let’s update the ‘routes.yml’ file to add the ‘_legacy_controller’ parameter:<\/p>\n\n\n\n
demo_tab_one:\n path: wkadmin-tabs\/demotabone\n methods: [GET]\n defaults:\n _controller: 'PrestaShop\\Module\\Wkadmintabs\\Controller\\Admin\\DemoTabOneController::indexAction'\n # _legacy_controller is used to manage permissions\n<strong> _legacy_controller: WkAdminTabsControllerTabsOne<\/strong>\n\ndemo_tab_two:\n path: wkadmin-tabs\/demotabtwo\n methods: [GET]\n defaults:\n _controller: 'PrestaShop\\Module\\Wkadmintabs\\Controller\\Admin\\DemoTabTwoController::indexAction'\n # _legacy_controller is used to manage permissions\n<strong> _legacy_controller: WkAdminTabsControllerTabsTwo<\/strong><\/pre>\n\n\n\nYou can also modify the error message and redirection link.<\/p>\n\n\n\n
@AdminSecurity("is_granted(['read'], request.get('_legacy_controller'))",\n message="You do not have permission to access this.",\n redirectRoute="some_route_name"\n)<\/pre>\n\n\n\nThat\u2019s all about this blog.<\/p>\n\n\n\n
If any issue or doubt please feel free to mention it in the comment section.<\/p>\n\n\n\n
I would be happy to help.<\/p>\n\n\n\n
Also, you can explore our PrestaShop Development Services<\/a> & a large range of quality PrestaShop Modules<\/a>.<\/p>\n\n\n\n
For any doubt contact us at support@webkul.com<\/a>.<\/p>\n","protected":false},"excerpt":{"rendered":"
![\"Create](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/10\/side_menu.png\")
![\"Create](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/10\/access_control.png\")