How to Enable Canonical Meta Tag in Magento 2
Vinh Jacker | 06-20-2016
The canonical meta tag in Magento 2 is a very important meta tag in SEO and using the canonical meta tag can improve your site ranking and concentrate pageviews. It helps a lot in solving duplicate content problems when there are multiple URLs containing identical or very similar content so that the search engines can index exactly your preferred URL. Scroll down to see the steps to enable Canonical Meta Tag for your Magento 2 store.
Steps to enable Canonical Meta Tag in Magento 2
Option 1
- On the Admin panel, click
Stores. In theSettingssection, selectConfiguration. - Select
CatalogunderCatalogin the panel on the left - Open the Search Engine Optimizations section, and continue with following:
Look at 2 last fields:
- If you want search engines to index only pages that have a full category path, do the following:
- In the
Use Canonical Link Meta Tag for Categoriesfield, selectYes - In the
Use Canonical Link Meta Tag for Productsfield, selectNo
- In the
- If you want search engines to index only product pages, do the following:
- In the
Use Canonical Link Meta Tag for Categoriesfield, selectNo - In the
Use Canonical Link Meta Tag for Productsfield, selectYes
- In the
- If you want search engines to index both Categories and Products, do the following:
- In the
Use Canonical Link Meta Tag for Categoriesfield, selectYes - In the
Use Canonical Link Meta Tag for Productsfield, selectYes
- In the
- When completing, click
Save Config.
Option 2
-
Set up your module.
-
Create a helper class, for example, [Namespace]/[Module]/Helper/Canonical.php.
<?php
declare(strict_types=1);
namespace [Namespace]\[Module]\Helper;
use Magento\Cms\Model\Page;
use Magento\Framework\App\Helper\AbstractHelper;
use Magento\Framework\App\Helper\Context;
/**
* Class Canonical
* @package [Namespace]\[Module]\Helper
*/
class Canonical extends AbstractHelper
{
/**
* @var Page
*/
protected $cmsPage;
/**
* Canonical constructor.
* @param Context $context
* @param Page $cmsPage
*/
public function __construct(
Context $context,
Page $cmsPage
) {
$this->cmsPage = $cmsPage;
parent::__construct($context);
}
/**
* This method is used in XML layout.
* @return string
*/
public function getCanonicalForAllCmsPages(): string
{
if ($this->cmsPage->getId()) {
return $this->createLink(
$this->scopeConfig->getValue('web/secure/base_url') . $this->cmsPage->getIdentifier()
);
}
return '';
}
/**
* @param $url
* @return string
*/
protected function createLink($url): string
{
return '<link rel="canonical" href="' . $url . '" />';
}
}
- Develop a layout file, for example, [[Namespace]/[Module]/view/frontend/layout/default.xml.
<?xml version="1.0"?>
<page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd">
<body>
<referenceBlock name="head.additional">
<container name="canonical.url.cms.page.container">
<block class="Magento\Framework\View\Element\Text" name="canonical.url.cms.page">
<arguments>
<argument name="label" xsi:type="string">Adding canonical link with base URL</argument>
<argument name="text" xsi:type="helper" helper="[Namespace]\[Module]\Helper\Canonical::getCanonicalForAllCmsPages"/>
</arguments>
</block>
</container>
</referenceBlock>
</body>
</page>
-
Execute [bin/magento setup:upgrade to apply the changes and register the new module.
-
Check if the result aligns with your desired outcome.
Recommendations
Increase traffic and boost sales with the most complete SEO solution for every store.
Check the Enabled Canonical URLs
The recommended best practice is to activate both of these settings. Once you have completed the configuration, click on Save, refresh your cache, and you should observe the canonical meta tag appearing on all your product pages and category pages.
Use CTRL + U to view your site source, and then CTRL + F to find canonical urls.
Final words
Enabling Canonical Meta Tag in Magento 2 solves duplication issues and brings your blog SEO to the next level. You can also check our SEO extension out to have a more thorough solution, or read below related posts for more information in this topic. Feel free to address any concerns you are having with us in the comment box!
Related topics
Jacker is the Chief Technology Officer (CTO) at Mageplaza, bringing over 10 years of experience in Magento, Shopify, and other eCommerce platforms. With deep technical expertise, he has led numerous successful projects, optimizing and scaling online stores for global brands. Beyond his work in eCommerce development, he is passionate about running and swimming.
Related Post
Change Welcome Message - Mageplaza
Customize the welcome message on your store's homepage to provide a personalized touch for your customers. Improve the user experience with our step-by-step guide.
Configure Magento 2 Contact Form & Email: Detailed Guides - Mageplaza
Configure the email address for your Magento 2 store's contact form and ensure that your customers can easily get in touch with you with this informative guide
How to Install Magento 2 with Sample Data - Mageplaza
How to install Magento 2 with Sample Data. In this topic we will discuss about How to Install Magento 2 Step by Step in Manage Store topic
6 Steps To Stop Brute Force Attacks - Mageplaza
How To Stop Brute Force Attacks in Magento 1, 2. In this topic we will discuss about How To Stop Brute Force Attacks in Manage Store topic
How to set Locale, Language, and Country in Magento 2 - Mageplaza
Setup Locale State Country in Magento 2 provides setup your store information on Locale Options that determines the timezone, language, country and the days.
Change Welcome Message - Mageplaza
Customize the welcome message on your store's homepage to provide a personalized touch for your customers. Improve the user experience with our step-by-step guide.
Configure Magento 2 Contact Form & Email: Detailed Guides - Mageplaza
Configure the email address for your Magento 2 store's contact form and ensure that your customers can easily get in touch with you with this informative guide
How to Install Magento 2 with Sample Data - Mageplaza
How to install Magento 2 with Sample Data. In this topic we will discuss about How to Install Magento 2 Step by Step in Manage Store topic
6 Steps To Stop Brute Force Attacks - Mageplaza
How To Stop Brute Force Attacks in Magento 1, 2. In this topic we will discuss about How To Stop Brute Force Attacks in Manage Store topic
How to set Locale, Language, and Country in Magento 2 - Mageplaza
Setup Locale State Country in Magento 2 provides setup your store information on Locale Options that determines the timezone, language, country and the days.