How to Get All Product URLs in Magento 2

The admin can create six different types of products in Magento 2 store and each time a product is created, a unique URL is created for that product page.

Now, when you are working with HTML sitemap in your Magento 2 store, you might need the list of all these product URLs. Manually creating this list is a tedious process and prone to error.

Hence, I have posted a programmatic solution to get all product URLs in Magento 2 store.

Using this solution, one can get all product URLs and use them while updating the product data, creating HTML sitemap for navigation purpose or simply track the URLs of the store.

Also, a store owner may maintain and update such a product list from time to time to monitor the store expansion and product performance.

In all such scenarios, follow the programmatic solution given below to get all product URLs in Magento 2.

Note: You might also find the solution to get all category URLs in Magento 2 helpful if you are creating HTML sitemap and landed to my post!

Steps to Get All Product URLs in Magento 2

1. Create registration.php at Vendor/Module.
   
   <?php use Magento\Framework\Component\ComponentRegistrar; ComponentRegistrar::register( ComponentRegistrar::MODULE, 'Vendor_Module', __DIR__ );

   1 2 3 4 5 6 7 8 9

   <?php   use Magento\Framework\Component\ComponentRegistrar;   ComponentRegistrar::register(     ComponentRegistrar::MODULE,     'Vendor_Module',     __DIR__ );

2. Create module.xml at Vendor/Module/etc.
   
   <?xml version="1.0"?> <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd"> <module name="Vendor_Module" setup_version="1.0.0"> </module> </config>

   1 2 3 4 5 6

   <?xml version="1.0"?> <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"         xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">     <module name="Vendor_Module" setup_version="1.0.0">     </module> </config>

3. Create ProductPageUrls.php at Vendor/Module/Helper.
   
   <?php namespace Vendor\Module\Helper; use Magento\Catalog\Model\ResourceModel\Product\CollectionFactory as ProductCollectionFactory; use Magento\Framework\App\Config\ScopeConfigInterface; use Magento\Framework\App\Helper\AbstractHelper; use Magento\Framework\App\Helper\Context; class ProductPageUrls extends AbstractHelper { const PRODUCT_URL_SUFFIX = 'catalog/seo/product_url_suffix'; /** * @var ProductCollectionFactory */ private $productCollectionFactory; public function __construct(Context $context, ProductCollectionFactory $productCollectionFactory) { $this->productCollectionFactory = $productCollectionFactory; parent::__construct($context); } public function getProductUrls() { $productUrls = []; $products = $this->productCollectionFactory->create(); $products->addAttributeToSelect('url_key'); foreach ($products as $product) { if (!is_null($product->getData('url_key'))) { $productUrls[] = rtrim($this->_getUrl($product->getData('url_key')), '/') . $this->getConfigData(self::PRODUCT_URL_SUFFIX); } } return $productUrls; } public function getConfigData($path, $scope = ScopeConfigInterface::SCOPE_TYPE_DEFAULT, $scopeId = null) { return $this->scopeConfig->getValue($path, $scope, $scopeId); } }

   1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44

   <?php   namespace Vendor\Module\Helper;   use Magento\Catalog\Model\ResourceModel\Product\CollectionFactory as ProductCollectionFactory; use Magento\Framework\App\Config\ScopeConfigInterface; use Magento\Framework\App\Helper\AbstractHelper; use Magento\Framework\App\Helper\Context;   class ProductPageUrls extends AbstractHelper {     const PRODUCT_URL_SUFFIX = 'catalog/seo/product_url_suffix';     /**      * @var ProductCollectionFactory      */     private $productCollectionFactory;       public function __construct(Context $context, ProductCollectionFactory $productCollectionFactory)     {         $this->productCollectionFactory = $productCollectionFactory;         parent::__construct($context);     }       public function getProductUrls()     {         $productUrls = [];           $products = $this->productCollectionFactory->create();         $products->addAttributeToSelect('url_key');         foreach ($products as $product) {             if (!is_null($product->getData('url_key'))) {                 $productUrls[] = rtrim($this->_getUrl($product->getData('url_key')), '/') .                     $this->getConfigData(self::PRODUCT_URL_SUFFIX);             }         }           return $productUrls;     }       public function getConfigData($path, $scope = ScopeConfigInterface::SCOPE_TYPE_DEFAULT, $scopeId = null)     {         return $this->scopeConfig->getValue($path, $scope, $scopeId);     } }

That’s it.

If you have any doubts regarding this post, just mention them in the Comments section below.

I would be happy to help.

Feel free to share the solution with Magento Community via social media.

Thank You.