Html Sitemap

Mage2Expert HTML Sitemap is an extension for Magento 2 that automatically generates a fully linked, user-facing sitemap page displaying all categories, products, CMS pages, and custom links from your store. The sitemap page is accessible at a configurable URL key (default: /html-sitemap) and renders a clean, sectioned layout with a live search bar that filters all visible links in real time without a page reload. Each section — Categories, Products, CMS Pages, and Custom Links — can be enabled or disabled independently, given a custom heading, assigned a sort order to control its position on the page, and limited to a maximum number of links with an optional "View More" button that reveals the remaining entries inline. Products are fetched via direct database queries against url_rewrite and EAV tables, bypassing the ElasticSearch or OpenSearch plugin stack entirely, so the sitemap is always accurate even when the search index is incomplete or rebuilding. CMS pages can be individually excluded from the sitemap using a comma-separated list of page identifiers in the admin. Custom links — arbitrary title and URL pairs that represent any internal or external page — are managed from a dedicated admin grid with full create, edit, delete, and enable/disable support. The sitemap page itself carries configurable SEO fields (Meta Title, Meta Keywords, Meta Description, and Meta Robots) and an optional canonical URL, giving full control over how search engines index the page. A 301 redirect preserves link equity if the URL key is changed after the page has already been indexed. All configuration is store-view scoped and available at Stores → Configuration → Mage2Expert → HTML Sitemap. 

Features

• Auto-Generated Sitemap Page — a fully linked HTML sitemap page is created automatically from live store data with no manual input required. All categories, enabled and individually-visible products, active CMS pages, and custom links are included by default.
• Configurable URL Key with 301 Redirect — the sitemap URL key defaults to html-sitemap and can be changed at any time from the admin. Changing it automatically issues a 301 redirect from the old URL to the new one, preserving any accumulated SEO value.
• Live Search Bar — a search input at the top of the sitemap filters all visible links across every section as the shopper types. Matching links are highlighted and non-matching links are hidden instantly without reloading the page.
• Per-Section Enable / Disable and Sort Order — Categories, Products, CMS Pages, and Custom Links each have their own enable toggle and numeric sort order field. Sections are rendered on the page in ascending sort order.
• Per-Section Max Links and View More Button — each section supports a configurable maximum number of links to display initially. When more links are available and View More is enabled, a button expands the section inline without navigating away from the page.
• ElasticSearch / OpenSearch Independent Product Query — products are loaded via a direct SQL query against url_rewrite, catalog_product_entity_varchar, and catalog_product_entity_int tables. The sitemap works correctly even when the search index is stale or unavailable.
• CMS Page Exclusions — enter a comma-separated list of CMS page identifiers (e.g. no-route,enable-cookies) in the admin to suppress specific pages from the sitemap without disabling the entire CMS Pages section.
• Custom Links Admin Grid — a dedicated grid at Mage2Expert → HTML Sitemap → Custom Links lets you add, edit, delete, enable, and reorder any number of custom title–URL pairs. Use it to link to external resources, non-catalog landing pages, or campaign URLs.
• Full SEO Meta Control — the sitemap page supports individual Meta Title, Meta Keywords, Meta Description, and Meta Robots fields, plus an optional canonical URL tag. All fields are store-view scoped.
• Custom Section Headings — the heading label for each section (Categories, Products, CMS Pages, Custom Links) is independently configurable so the page matches your store's language and brand voice.
• Configurable Page Title — the H1 page title displayed at the top of the sitemap page is set from the admin and can be translated per store view.
• Store-View Scope Throughout — all general, sections, and SEO configuration fields are fully store-view scoped, making the extension compatible with multi-store and multi-language Magento setups from the start.
• Enable / Disable without Uninstalling — a master Enable switch under General settings hides all frontend output and admin UI while preserving every configuration value and custom link record. Re-enabling restores everything immediately.
• Zero Core Code Modifications — built on Magento's layout XML, plugin, router, and observer architecture. No class rewrites, no preferences, no patches. Safe alongside Magento upgrades and other extensions.

How It Works

After enabling the extension, navigate to Stores → Configuration → Mage2Expert → HTML Sitemap. Under General Settings confirm the URL Key (default: html-sitemap) and enable the sections you want to display. Under each section tab — Categories, Products, CMS Pages, Custom Links — set the section title, sort order, and maximum links. Save the configuration and visit /html-sitemap on the frontend. The page renders immediately with all live data; no cache flush, no reindex, and no additional setup steps are required. 

To add a custom link, go to Mage2Expert → HTML Sitemap → Custom Links, click Add New Link, enter a title, URL, sort order, and active status, then save. The link appears in the Custom Links section on the sitemap page on the next page load. 

Categories Section

All active categories from level 2 and below are collected via Magento's native category collection with URL rewrite resolution. The category list respects store-view scope, so only categories assigned to the current store view are included. The section heading, sort order, maximum visible links, and View More toggle are all configurable independently. 

Products Section

Products are fetched using a direct SQL query that joins url_rewrite, catalog_product_entity_varchar (product name), and catalog_product_entity_int (status and visibility) tables. Only enabled products with visibility set to Catalog or Catalog, Search are included. This approach bypasses ElasticSearch and OpenSearch completely, so the Products section is always accurate regardless of the index state. Results are sorted alphabetically by product name. 

CMS Pages Section

Active CMS pages assigned to the current store view are listed with their page title and URL. Pages that should never appear on the sitemap — such as the 404 page, cookie notice, or privacy policy — can be excluded individually by entering their identifier in the Excluded CMS Pages field rather than toggling the entire section off. 

Custom Links

Custom links are managed from a full CRUD admin grid at Mage2Expert → HTML Sitemap → Custom Links. Each record stores a title, URL, sort order, and active flag. The section supports any number of links and does not apply a maximum-links or View More limit — all active custom links are always shown when the section is enabled. 

URL Key Management

The sitemap URL key is entered in General Settings and registered dynamically via a custom RouterInterface implementation. When the URL key is changed and saved, the extension automatically registers a 301 redirect from the previous URL to the new one on the next request to the old address. This ensures that any external links, bookmarks, or search-engine-indexed URLs continue to resolve without a 404, and that any accumulated page authority is transferred to the new URL. 

SEO

The sitemap page is treated as a first-class SEO asset. The Meta Title, Meta Keywords, Meta Description, and Meta Robots fields are available in the SEO tab of the configuration section and are injected into the page <head> on every request. An optional canonical URL tag can be configured to point search engines to the preferred address when multiple URLs resolve to the same page. All SEO fields are store-view scoped. 

Use Cases

• Large catalogues — give search engine crawlers a single entry point to discover every product and category URL without relying on XML sitemaps or crawl paths through navigation.
• Stores with ElasticSearch or OpenSearch — maintain a reliable product listing page that is never affected by a stale or unavailable search index.
• Multi-language stores — configure separate section headings, page titles, and SEO fields per store view to present a localised sitemap for each language.
• Campaign and landing pages — add external or non-catalog URLs as custom links to include them in the sitemap and make them discoverable to both shoppers and crawlers.
• CMS-heavy stores — list all active content pages in one place and exclude system pages (404, cookie notice, privacy policy) individually rather than hiding the entire CMS section.