{"id":135362,"date":"2018-07-25T13:04:38","date_gmt":"2018-07-25T13:04:38","guid":{"rendered":"https:\/\/webkul.com\/blog\/?p=135362"},"modified":"2024-02-22T14:08:46","modified_gmt":"2024-02-22T14:08:46","slug":"add-custom-block-and-link-header-in-magento-2","status":"publish","type":"post","link":"https:\/\/webkul.com\/blog\/add-custom-block-and-link-header-in-magento-2\/","title":{"rendered":"Add Custom Block and Link Header in Magento 2"},"content":{"rendered":"\n

In this article, we will learn how to call a custom link and block in the header in Magento 2.<\/p>\n\n\n\n

So, the file (default.xml<\/strong>) is used to define configurations of the header. This file will be located under\u00a0app\/code\/Namespace\/Module\/view\/frontend\/layout\/.\u00a0<\/strong>This file calls on every page, that\u2019s why we write code for the header in this file.<\/p>\n\n\n\n

<?xml version="1.0"?>\n<page xmlns:xsi="http:\/\/www.w3.org\/2001\/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:View\/Layout\/etc\/page_configuration.xsd">\n<body>\n \u00a0\u00a0\u00a0\u00a0<referenceBlock name="header.links">\n       <block class="Magento\\Framework\\View\\Element\\Html\\Link" name="webkul-top-link">\n         <arguments>\n           <argument name="label" xsi:type="string" translate="true">Test Link<\/argument>\n           <argument name="path" xsi:type="string">test\/test<\/argument>\n         <\/arguments>\n       <\/block>\n \u00a0\u00a0\u00a0\u00a0<\/referenceBlock>\n<\/body>\n<\/page><\/pre>\n\n\n\n
Now If you want to add your custom block inside the header,
The below code will be used :<\/p>\n\n\n\n
<?xml version="1.0"?>\n<page xmlns:xsi="http:\/\/www.w3.org\/2001\/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:View\/Layout\/etc\/page_configuration.xsd">\n<body>\n \u00a0\u00a0\u00a0\u00a0<referenceBlock name="header.links">\n       <block class="Webkul\\Test\\Block\\Link" name="webkul-top-link">\n         <arguments>\n           <argument name="label" xsi:type="string" translate="true">Test Link<\/argument>\n           <argument name="path" xsi:type="string">test\/test<\/argument>\n         <\/arguments>\n       <\/block>\n \u00a0\u00a0\u00a0\u00a0<\/referenceBlock>\n<\/body>\n<\/page><\/pre>\n\n\n\n
Now, create\u00a0Link.php<\/strong>\u00a0at location app\/code\/Webkul\/Test\/Block<\/strong> and add the below code.<\/p>\n\n\n\n
<?php\n \nnamespace Webkul\\Test\\Block;\n \nclass Link extends \\Magento\\Framework\\View\\Element\\Html\\Link\n{\n  \/**\n   * Render block HTML.\n   *\n   * @return string\n  *\/\n  protected function _toHtml() {\n \u00a0\u00a0\u00a0if (false != $this->getTemplate()) {\n \u00a0\u00a0\u00a0  return parent::_toHtml();\n \u00a0\u00a0\u00a0}\n \u00a0\u00a0\u00a0$label = $this->escapeHtml($this->getLabel());\n    return '<li><a ' . $this->getLinkAttributes() . ' >' . $label . '<\/a><\/li>';\n\n  }\n}<\/pre>\n\n\n\n
Now flush the cache of the Magento by running the below command:
php bin\/<\/em>magento cache:flush<\/em><\/strong><\/p>\n\n\n
\n
\"Image\"<\/figure>\n<\/div>\n\n\n
You will see the top link on your store like below.
<\/p>\n\n\n\n
In this way, you can create custom top links.
Hope it will help you. Thank you.<\/p>\n","protected":false},"excerpt":{"rendered":"
In this article, we will learn how to call a custom link and block in the header in Magento 2. So, the file (default.xml) is used to define configurations of the header. This file will be located under\u00a0app\/code\/Namespace\/Module\/view\/frontend\/layout\/.\u00a0This file calls on every page, that\u2019s why we write code for the header in this file. Now […]<\/a><\/p>\n","protected":false},"author":171,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[302],"tags":[7191,7190,7188,2460,7189],"class_list":["post-135362","post","type-post","status-publish","format-standard","hentry","category-magento2","tag-call-custom-block-and-links-in-header","tag-custom-link-on-header","tag-header-links","tag-magento-2","tag-top-links"],"yoast_head":"\nAdd Custom Block and Link Header in Magento 2 - Webkul Blog<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/webkul.com\/blog\/add-custom-block-and-link-header-in-magento-2\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Add Custom Block and Link Header in Magento 2 - Webkul Blog\" \/>\n<meta property=\"og:description\" content=\"In this article, we will learn how to call a custom link and block in the header in Magento 2. So, the file (default.xml) is used to define configurations of the header. This file will be located under\u00a0app\/code\/Namespace\/Module\/view\/frontend\/layout\/.\u00a0This file calls on every page, that\u2019s why we write code for the header in this file. Now [...]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/webkul.com\/blog\/add-custom-block-and-link-header-in-magento-2\/\" \/>\n<meta property=\"og:site_name\" content=\"Webkul Blog\" \/>\n<meta property=\"article:publisher\" content=\"https:\/\/www.facebook.com\/webkul\/\" \/>\n<meta property=\"article:published_time\" content=\"2018-07-25T13:04:38+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2024-02-22T14:08:46+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2018\/07\/testLink.png\" \/>\n<meta name=\"author\" content=\"Anuj Gupta\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:creator\" content=\"@webkul\" \/>\n<meta name=\"twitter:site\" content=\"@webkul\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Anuj Gupta\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"1 minute\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\/\/webkul.com\/blog\/add-custom-block-and-link-header-in-magento-2\/#article\",\"isPartOf\":{\"@id\":\"https:\/\/webkul.com\/blog\/add-custom-block-and-link-header-in-magento-2\/\"},\"author\":{\"name\":\"Anuj Gupta\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/person\/8b6a9038345794233c3cf41b15a330c4\"},\"headline\":\"Add Custom Block and Link Header in Magento 2\",\"datePublished\":\"2018-07-25T13:04:38+00:00\",\"dateModified\":\"2024-02-22T14:08:46+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\/\/webkul.com\/blog\/add-custom-block-and-link-header-in-magento-2\/\"},\"wordCount\":151,\"commentCount\":0,\"publisher\":{\"@id\":\"https:\/\/webkul.com\/blog\/#organization\"},\"image\":{\"@id\":\"https:\/\/webkul.com\/blog\/add-custom-block-and-link-header-in-magento-2\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2018\/07\/testLink.png\",\"keywords\":[\"call custom block and links in header\",\"custom link on header\",\"header links\",\"Magento 2\",\"top links\"],\"articleSection\":[\"Magento2\"],\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\/\/webkul.com\/blog\/add-custom-block-and-link-header-in-magento-2\/#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/webkul.com\/blog\/add-custom-block-and-link-header-in-magento-2\/\",\"url\":\"https:\/\/webkul.com\/blog\/add-custom-block-and-link-header-in-magento-2\/\",\"name\":\"Add Custom Block and Link Header in Magento 2 - Webkul Blog\",\"isPartOf\":{\"@id\":\"https:\/\/webkul.com\/blog\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\/\/webkul.com\/blog\/add-custom-block-and-link-header-in-magento-2\/#primaryimage\"},\"image\":{\"@id\":\"https:\/\/webkul.com\/blog\/add-custom-block-and-link-header-in-magento-2\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2018\/07\/testLink.png\",\"datePublished\":\"2018-07-25T13:04:38+00:00\",\"dateModified\":\"2024-02-22T14:08:46+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/webkul.com\/blog\/add-custom-block-and-link-header-in-magento-2\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/webkul.com\/blog\/add-custom-block-and-link-header-in-magento-2\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/webkul.com\/blog\/add-custom-block-and-link-header-in-magento-2\/#primaryimage\",\"url\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2018\/07\/testLink.png\",\"contentUrl\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2018\/07\/testLink.png\",\"width\":\"1298\",\"height\":\"676\"},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/webkul.com\/blog\/add-custom-block-and-link-header-in-magento-2\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/webkul.com\/blog\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Add Custom Block and Link Header in Magento 2\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/webkul.com\/blog\/#website\",\"url\":\"https:\/\/webkul.com\/blog\/\",\"name\":\"Webkul Blog\",\"description\":\"\",\"publisher\":{\"@id\":\"https:\/\/webkul.com\/blog\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/webkul.com\/blog\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/webkul.com\/blog\/#organization\",\"name\":\"WebKul Software Private Limited\",\"url\":\"https:\/\/webkul.com\/blog\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-logo-accent-sq.png\",\"contentUrl\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-logo-accent-sq.png\",\"width\":380,\"height\":380,\"caption\":\"WebKul Software Private Limited\"},\"image\":{\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/logo\/image\/\"},\"sameAs\":[\"https:\/\/www.facebook.com\/webkul\/\",\"https:\/\/x.com\/webkul\",\"https:\/\/www.instagram.com\/webkul\/\",\"https:\/\/www.linkedin.com\/company\/webkul\",\"https:\/\/www.youtube.com\/user\/webkul\/\"]},{\"@type\":\"Person\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/person\/8b6a9038345794233c3cf41b15a330c4\",\"name\":\"Anuj Gupta\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/person\/image\/\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/a46d5e8da91ff0fecc16beee97bfb7b3a8ed158c64c69f50ddc3c1ce7d532e97?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Fmike.png&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/a46d5e8da91ff0fecc16beee97bfb7b3a8ed158c64c69f50ddc3c1ce7d532e97?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Fmike.png&r=g\",\"caption\":\"Anuj Gupta\"},\"url\":\"https:\/\/webkul.com\/blog\/author\/anuj-gupta701\/\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Add Custom Block and Link Header in Magento 2 - Webkul Blog","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/webkul.com\/blog\/add-custom-block-and-link-header-in-magento-2\/","og_locale":"en_US","og_type":"article","og_title":"Add Custom Block and Link Header in Magento 2 - Webkul Blog","og_description":"In this article, we will learn how to call a custom link and block in the header in Magento 2. So, the file (default.xml) is used to define configurations of the header. This file will be located under\u00a0app\/code\/Namespace\/Module\/view\/frontend\/layout\/.\u00a0This file calls on every page, that\u2019s why we write code for the header in this file. Now [...]","og_url":"https:\/\/webkul.com\/blog\/add-custom-block-and-link-header-in-magento-2\/","og_site_name":"Webkul Blog","article_publisher":"https:\/\/www.facebook.com\/webkul\/","article_published_time":"2018-07-25T13:04:38+00:00","article_modified_time":"2024-02-22T14:08:46+00:00","og_image":[{"url":"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2018\/07\/testLink.png","type":"","width":"","height":""}],"author":"Anuj Gupta","twitter_card":"summary_large_image","twitter_creator":"@webkul","twitter_site":"@webkul","twitter_misc":{"Written by":"Anuj Gupta","Est. reading time":"1 minute"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/webkul.com\/blog\/add-custom-block-and-link-header-in-magento-2\/#article","isPartOf":{"@id":"https:\/\/webkul.com\/blog\/add-custom-block-and-link-header-in-magento-2\/"},"author":{"name":"Anuj Gupta","@id":"https:\/\/webkul.com\/blog\/#\/schema\/person\/8b6a9038345794233c3cf41b15a330c4"},"headline":"Add Custom Block and Link Header in Magento 2","datePublished":"2018-07-25T13:04:38+00:00","dateModified":"2024-02-22T14:08:46+00:00","mainEntityOfPage":{"@id":"https:\/\/webkul.com\/blog\/add-custom-block-and-link-header-in-magento-2\/"},"wordCount":151,"commentCount":0,"publisher":{"@id":"https:\/\/webkul.com\/blog\/#organization"},"image":{"@id":"https:\/\/webkul.com\/blog\/add-custom-block-and-link-header-in-magento-2\/#primaryimage"},"thumbnailUrl":"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2018\/07\/testLink.png","keywords":["call custom block and links in header","custom link on header","header links","Magento 2","top links"],"articleSection":["Magento2"],"inLanguage":"en-US","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/webkul.com\/blog\/add-custom-block-and-link-header-in-magento-2\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/webkul.com\/blog\/add-custom-block-and-link-header-in-magento-2\/","url":"https:\/\/webkul.com\/blog\/add-custom-block-and-link-header-in-magento-2\/","name":"Add Custom Block and Link Header in Magento 2 - Webkul Blog","isPartOf":{"@id":"https:\/\/webkul.com\/blog\/#website"},"primaryImageOfPage":{"@id":"https:\/\/webkul.com\/blog\/add-custom-block-and-link-header-in-magento-2\/#primaryimage"},"image":{"@id":"https:\/\/webkul.com\/blog\/add-custom-block-and-link-header-in-magento-2\/#primaryimage"},"thumbnailUrl":"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2018\/07\/testLink.png","datePublished":"2018-07-25T13:04:38+00:00","dateModified":"2024-02-22T14:08:46+00:00","breadcrumb":{"@id":"https:\/\/webkul.com\/blog\/add-custom-block-and-link-header-in-magento-2\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/webkul.com\/blog\/add-custom-block-and-link-header-in-magento-2\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/webkul.com\/blog\/add-custom-block-and-link-header-in-magento-2\/#primaryimage","url":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2018\/07\/testLink.png","contentUrl":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2018\/07\/testLink.png","width":"1298","height":"676"},{"@type":"BreadcrumbList","@id":"https:\/\/webkul.com\/blog\/add-custom-block-and-link-header-in-magento-2\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/webkul.com\/blog\/"},{"@type":"ListItem","position":2,"name":"Add Custom Block and Link Header in Magento 2"}]},{"@type":"WebSite","@id":"https:\/\/webkul.com\/blog\/#website","url":"https:\/\/webkul.com\/blog\/","name":"Webkul Blog","description":"","publisher":{"@id":"https:\/\/webkul.com\/blog\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/webkul.com\/blog\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/webkul.com\/blog\/#organization","name":"WebKul Software Private Limited","url":"https:\/\/webkul.com\/blog\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/webkul.com\/blog\/#\/schema\/logo\/image\/","url":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-logo-accent-sq.png","contentUrl":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-logo-accent-sq.png","width":380,"height":380,"caption":"WebKul Software Private Limited"},"image":{"@id":"https:\/\/webkul.com\/blog\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/www.facebook.com\/webkul\/","https:\/\/x.com\/webkul","https:\/\/www.instagram.com\/webkul\/","https:\/\/www.linkedin.com\/company\/webkul","https:\/\/www.youtube.com\/user\/webkul\/"]},{"@type":"Person","@id":"https:\/\/webkul.com\/blog\/#\/schema\/person\/8b6a9038345794233c3cf41b15a330c4","name":"Anuj Gupta","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/webkul.com\/blog\/#\/schema\/person\/image\/","url":"https:\/\/secure.gravatar.com\/avatar\/a46d5e8da91ff0fecc16beee97bfb7b3a8ed158c64c69f50ddc3c1ce7d532e97?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Fmike.png&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/a46d5e8da91ff0fecc16beee97bfb7b3a8ed158c64c69f50ddc3c1ce7d532e97?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Fmike.png&r=g","caption":"Anuj Gupta"},"url":"https:\/\/webkul.com\/blog\/author\/anuj-gupta701\/"}]}},"amp_enabled":true,"_links":{"self":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts\/135362","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/users\/171"}],"replies":[{"embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/comments?post=135362"}],"version-history":[{"count":17,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts\/135362\/revisions"}],"predecessor-version":[{"id":423913,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts\/135362\/revisions\/423913"}],"wp:attachment":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/media?parent=135362"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/categories?post=135362"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/tags?post=135362"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}