{"id":719,"date":"2019-12-25T10:00:22","date_gmt":"2019-12-25T10:00:22","guid":{"rendered":"https:\/\/meetanshi.com\/blog\/2019\/12\/25\/magento-2-routing\/"},"modified":"2025-05-21T17:57:33","modified_gmt":"2025-05-21T12:27:33","slug":"magento-2-routing","status":"publish","type":"post","link":"https:\/\/meetanshi.com\/blog\/magento-2-routing\/","title":{"rendered":"A Complete Tutorial On Magento 2 Routing"},"content":{"rendered":"\n

Merry Christmas <\/em><\/p>\n\n\n\n

Magento 2 routing<\/strong> defines a URL of the module.<\/p>\n\n\n\n

The entire Magento 2 application flow is based on processing URL request and router classes which are responsible for matching and processing that requests.<\/p>\n\n\n\n

The request URL in Magento 2 is http:\/\/example.com\/index.php\/router_name\/controller\/action<\/p>\n\n\n\n

Here, the router_name<\/strong> is used to find the module.<\/p>\n\n\n\n

When a request is made in Magento 2, controller\/action: index.php \u2192 HTTP app \u2192 FrontController \u2192 Routing \u2192 Controller processing \u2192 etc<\/strong> flow is followed.<\/p>\n\n\n\n

The FrontController is called in Http class to routing the request which will find the controller\/action match.<\/p>\n\n\n\n

vendor\/magento\/framework\/App\/FrontController.php<\/em><\/strong><\/p>\n\n\n\n

use Magento\\Framework\\App\\Action\\AbstractAction;\nuse Magento\\Framework\\App\\RouterInterface;\nuse Magento\\Framework\\Exception\\NotFoundException;\nuse Magento\\Framework\\Profiler;\n\n{\n    Profiler::start('routers_match');\n    $routingCycleCounter = 0;\n    $result = null;\n    while (!$request->isDispatched() && $routingCycleCounter++ < 100) {\n        \/** @var RouterInterface $router *\/\n        foreach ($this->_routerList as $router) {\n            try {\n                $actionInstance = $router->match($request);\n                if ($actionInstance) {\n                    $request->setDispatched(true);\n                    $this->response->setNoCacheHeaders();\n                    if ($actionInstance instanceof AbstractAction) {\n                        $result = $actionInstance->dispatch($request);\n                    } else {\n                        $result = $actionInstance->execute();\n                    }\n                    break;\n                }\n            } catch (NotFoundException $e) {\n                $request->initForward();\n                $request->setActionName('noroute');\n                $request->setDispatched(false);\n                break;\n            }\n        }\n    }\n    Profiler::stop('routers_match');\n    if ($routingCycleCounter > 100) {\n        throw new LogicException('Front controller reached 100 router match iterations');\n    }\n    return $result;\n}<\/pre>\n\n\n\n
Steps to create a custom route on frontend and admin:<\/h2>\n\n\n\n
Prior to implementing the below method, you may refer to the Magento 2 module development tutorial<\/a>.<\/p>\n\n\n\n
Create a frontend route:<\/h3>\n\n\n\n
Create routes.xml<\/strong> in app\/code\/[Vendor]\/[Module]\/etc\/frontend<\/em><\/strong> Folder add the following code:<\/p>\n\n\n\n
<?xml version=\"1.0\" ?>\n<config xmlns:xsi=\"http:\/\/www.w3.org\/2001\/XMLSchema-instance\"\n        xsi:noNamespaceSchemaLocation=\"urn:magento:framework:App\/etc\/routes.xsd\">\n    <router id=\"standard\">\n        <route frontName=\"helloworld\" id=\"helloworld\">\n            <module name=\"[Vendor]_[Module]\"\/>\n        <\/route>\n    <\/router>\n<\/config><\/pre>\n\n\n\n
Create admin route:<\/h3>\n\n\n\n
Create routes.xml<\/strong> in app\/code\/[Vendor]\/[Module]\/etc\/adminhtml<\/em><\/strong> folder and add the following code:<\/p>\n\n\n\n
<?xml version=\"1.0\"?>\n<config xmlns:xsi=\"http:\/\/www.w3.org\/2001\/XMLSchema-instance\"\n        xsi:noNamespaceSchemaLocation=\"urn:magento:framework:App\/etc\/routes.xsd\">\n    <router id=\"admin\">\n        <route id=\"helloworld\" frontName=\"helloworld\">\n            <module name=\"[Vendor]_[Module]\"\/>\n        <\/route>\n    <\/router>\n<\/config><\/pre>\n\n\n\n
Use route to rewrite controller:<\/h3>\n\n\n\n
Create routes.xml<\/strong> in app\/code\/[Vendor]\/[Module]\/etc\/frontend<\/em><\/strong> Folder and add the following code:<\/p>\n\n\n\n
<?xml version=\"1.0\"?>\n<config xmlns:xsi=\"http:\/\/www.w3.org\/2001\/XMLSchema-instance\"\n        xsi:noNamespaceSchemaLocation=\"urn:magento:framework:App\/etc\/routes.xsd\">\n    <router id=\"standard\">\n        <route frontName=\"helloworld\" id=\"helloworld\">\n            <module name=\"[Vendor]_[Module]\"\/>\n        <\/route>\n        <route id=\"account\">\n            <module name=\"[Vendor]_[Module]\" before=\"Magento_Customer\"\/>\n        <\/route>\n    <\/router>\n<\/config><\/pre>\n\n\n\n
That\u2019s all about Magento 2 Routing!<\/p>\n","protected":false},"excerpt":{"rendered":"
Merry Christmas Magento 2 routing defines a URL of the module. The entire Magento 2 application flow is based on processing URL request and router…<\/p>\n","protected":false},"author":5,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[34],"tags":[],"class_list":["post-719","post","type-post","status-publish","format-standard","hentry","category-magento"],"acf":[],"_links":{"self":[{"href":"https:\/\/meetanshi.com\/blog\/wp-json\/wp\/v2\/posts\/719","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/meetanshi.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/meetanshi.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/meetanshi.com\/blog\/wp-json\/wp\/v2\/users\/5"}],"replies":[{"embeddable":true,"href":"https:\/\/meetanshi.com\/blog\/wp-json\/wp\/v2\/comments?post=719"}],"version-history":[{"count":3,"href":"https:\/\/meetanshi.com\/blog\/wp-json\/wp\/v2\/posts\/719\/revisions"}],"predecessor-version":[{"id":14012,"href":"https:\/\/meetanshi.com\/blog\/wp-json\/wp\/v2\/posts\/719\/revisions\/14012"}],"wp:attachment":[{"href":"https:\/\/meetanshi.com\/blog\/wp-json\/wp\/v2\/media?parent=719"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/meetanshi.com\/blog\/wp-json\/wp\/v2\/categories?post=719"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/meetanshi.com\/blog\/wp-json\/wp\/v2\/tags?post=719"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}