How to get category URL in multiple stores

Question

I'm trying to generate the href links for our multilingual Magento 2 site, and as the category slug changes, I cannot simply replace the store code in the URL.

I've code is given below :

        $category = $this->_registry->registry('current_category');

        if (!$category->getId()) {
            throw new LocalizedException(__('Failed to initialize category'));
        }

        $categoryId = $category->getId();

        foreach ($this->_storeManager->getStores() as $store) {
            $locale = $this->_scopeConfig->getValue('general/locale/code', \Magento\Store\Model\ScopeInterface::SCOPE_STORE, $store->getStoreId());
            $category->setStoreId($store->getStoreId());
            $category->load($categoryId);

            if($category->getIsActive())
            {
                $output[$locale] = $category->getUrl();
            }
        }

It seems to work except that the $category->getUrl() always return the current store URL, even if I loaded the category from another store. Is it a bug or should I do something else?

So how get multiple store category URL ?

Answer 1

It seems to work except that the $category->getUrl() always return the current store URL, even if I loaded the category from another store. Is it a bug or should I do something else?

I've just encountered the same issue in Magento 2.3.3, It looks like an issue in the Category Model where the Url is loaded for a different store.

I ended up by setting the storeId on the UrlInstance before loading the url:

$category = $this->categoryRepository->get($categoryId, $storeId);
$category->getUrlInstance()->setScope($storeId);
$url = $category->getUrl();

// Exprienced issue : Fixed, Need to reset current store id so in page after this call, we will get proper store data
$category->getUrlInstance()->setScope($currentStoreId);

But I think this still should be fixed in the core model Category::getUrl().

Hope this will help.

Answer 2

The best solution I found so far comes from the following GitHub Magento 2 Seo module: https://github.com/staempfli/magento2-module-seo/

Especially from this class: https://github.com/staempfli/magento2-module-seo/blob/develop/Service/HrefLang/CategoryUrlRetriever.php

/**
 * @param int $identifier the category ID
 * @param Store $store
 * @return string
 */
public function getUrl($identifier, $store)
{
    /** @var Category $category */
    $category = $this->registry->registry('category');
    if(!$category) {
        $category = $this->categoryRepository->get($identifier, $store->getId());
    }
    $path = $this->categoryUrlPathGenerator->getUrlPathWithSuffix($category);
    return $store->getBaseUrl() . $path;
}

Where $this->categoryUrlPathGenerator is the object of Magento\CatalogUrlRewrite\Model\CategoryUrlPathGenerator

Answer 3

You should use the category repository to load the category for a specific store.

Inject the category repository in your constructor (alternative use the object manager):

\Magento\Catalog\Model\CategoryRepository $categoryRepository,

In your foreach loop replace the the category loading with the following:

$category = $this->categoryRepository->get($categoryId, $store->getStoreId());