Download the PHP package mage2kishan/module-xml-sitemap without Composer

Panth XML Sitemap — Sharded XML Sitemap, Hreflang, Image & Video Tags for Magento 2 (Hyva + Luma)

[]()

A complete XML sitemap replacement for Magento 2. One module runs the full pipeline — per-store sitemap profiles, seven entity-type contributors (product, category, CMS, landing page, blog, video, additional links), hreflang alternate tags, image tags, video tags, auto-split at a configurable URL threshold, gzip compression, an admin-toggleable XSL stylesheet, Google / Bing ping on write, a delta tracker so only changed entities regenerate, an async AMQP shard queue, a nightly cron, and a CLI generator. The final /panth-sitemap.xml is served by the module's frontend controller via url_rewrite, so the request never touches the legacy core Magento_Sitemap router. Works identically on Hyva and Luma.

Magento's native XML sitemap is a single blob written to disk by a cron job that re-crawls every product in the catalog on every run. There is no hreflang handling, no incremental regeneration, no sharding (so once you cross Google's 50,000-URL / 50 MB-uncompressed-per-file limit you silently drop URLs), no async work queue, no CMS-block-aware contributors, and no ping-on-write. Panth XML Sitemap replaces that pipeline with a sharded, delta-tracked, queue-backed generator that writes hreflang / image / video tags for every URL, splits shards automatically at the configured threshold, gzips them, pings search engines, and serves the final sitemap index through a Magento controller — so CDN rules, caching headers, and url_rewrite precedence all behave predictably.

Need Custom Magento 2 Development?

Table of Contents

• Preview
• Features
• How It Works
• Compatibility
• Installation
• Verify
• Configuration
• Managing Sitemap Profiles
• Frontend Endpoint
• CLI
• Cron
• Troubleshooting
• Support

Preview

Live walkthrough

End-to-end admin flow — open the XML Sitemap config, toggle a few fields, edit the default profile, flip entity types and per-type priorities, run Generate Now, and click View Sitemap. Click to play.

Admin

System configuration — Stores → Configuration → Panth Extensions → XML Sitemap. Six collapsible groups (General, Generation, Hreflang, Images & Video, Search Engine Ping, Additional Links) cover every global default.

Sitemap Profiles grid — one row per profile with columns for ID, Name, Store View (resolved from store_id), Entity Types (CSV of product/category/cms/custom), Active, URL Count, File Count, Last Generated, Cron flag, and per-row Edit / Generate Now / View Sitemap / Delete actions.

Edit Sitemap Profile form — eight collapsible sections: General, Entity Types (multi-select), Product Settings, Category Settings, CMS Page Settings, Custom Links, Advanced Settings (max URLs per file, video + hreflang xmlns toggles, output path with {store_code}), Scheduling, and read-only Generation Status populated after each run.

Frontend

/sitemap/<store_code>/sitemap_index.xml — the XSL stylesheet renders a human-readable table view of the sitemap index in the browser while the underlying response stays a valid XML sitemap for crawlers.

Features

How It Works

Six cooperating pieces:

1. Controller\Sitemap\Index at route xml_sitemap/sitemap/index serves GET /panth-sitemap.xml with Content-Type: application/xml; charset=utf-8, streaming the generated sitemap index (or a single shard when the request path includes a shard identifier). The controller reads from the pub/media/panth-sitemap/<store_code>/ directory where shards live, or from the sitemap_index.xml blob stored in panth_seo_sitemap_shard for the fast path.
2. Setup\Patch\Data\InstallSitemapRewrite writes the url_rewrite row that maps /panth-sitemap.xml to xml_sitemap/sitemap/index at install time. RefreshSitemapRewrite re-points any stale target_path left behind by Panth_AdvancedSEO so upgrades are a no-op. InstallSitemapTables ensures panth_seo_sitemap_profile + panth_seo_sitemap_shard exist when upgrading from a pre-1.0 installation that didn't have them.
3. Model\Sitemap\Builder (implements Api\BuilderInterface) is the orchestrator. Given a profile ID it (a) resolves the store scope, (b) iterates every registered contributor in deterministic order, (c) pipes each URL through ShardWriter, (d) closes each shard when the threshold is hit, (e) writes the top-level sitemap_index.xml via IndexWriter, (f) persists the run metadata via DeltaTracker, and (g) dispatches to SearchEnginePinger on success. Contributors are registered via di.xml in an ordered list so stores can disable one type without touching code.
4. Queue\ShardConsumer (wired when enable_queue = 1) consumes the panth_xml_sitemap.shard AMQP topic. Each message is a single profile-id + contributor-name + shard-index tuple; the consumer rebuilds just that shard, writes it to disk (or gzipped to disk), updates the delta row, and ACKs. Failed shards retry with exponential backoff before landing on the dead-letter topic.
5. Cron\Rebuild fires on the configured schedule (0 2 * * * by default). For every active profile whose cron window matches the current run, it either (a) dispatches shard-generation jobs to the queue when enable_queue = 1, or (b) synchronously calls Builder::generate() when the queue is off. Logs the run ID, profile ID, duration and URL count to var/log/panth_xml_sitemap.log.
6. Console\GenerateCommand registers panth:seo:sitemap:generate in etc/di.xml under the Magento console command pool. Used for manual runs, CI pipelines that need a fresh sitemap after a deploy, and troubleshooting — the command emits progress lines per contributor so the operator sees exactly which contributor / store_view / shard is in flight.

Compatibility

Installation

Verify

Visit Admin → Panth Infotech → XML Sitemap → Sitemap Profiles to see the seeded profile for each active store.

Configuration

Navigate to Stores → Configuration → Panth Infotech → XML Sitemap.

General

Features

Search Engine Ping

Queue & Delta

Every setting resolves at store-view scope, so each store can have a different URL cap, gzip flag, hreflang flag, ping policy, or queue flag.

Managing Sitemap Profiles

Open Admin → Panth Infotech → XML Sitemap → Sitemap Profiles to reach the grid (route panth_xml_sitemap/profile/index).

Fields

Mass actions

Select rows and choose Enable, Disable, Regenerate Now or Delete from the grid mass-action menu. "Regenerate Now" is a shortcut that dispatches a full rebuild for every selected profile, bypassing the delta tracker once.

Frontend Endpoint

• URL: GET /panth-sitemap.xml
• Content-Type: application/xml; charset=utf-8
• Controller: Panth\XmlSitemap\Controller\Sitemap\Index at route xml_sitemap/sitemap/index.

/panth-sitemap.xml is served by our controller via a url_rewrite row installed by Setup\Patch\Data\InstallSitemapRewrite. The core Magento_Sitemap module's filesystem-based sitemap is unaffected — Panth XML Sitemap deliberately uses a different URL so you can keep the native sitemap around for comparison during the first week after install.

If you are upgrading from Panth_AdvancedSEO where /panth-sitemap.xml was already mapped to that module's controller, the RefreshSitemapRewrite patch runs on the next setup:upgrade and rewrites the stale target_path to point at the new controller — zero manual DB surgery required.

Sitemap index shape

Individual shard shape

CLI

The module exposes a Magento console command for manual and CI-driven runs:

Output on a typical 50k-product run:

Exit codes: 0 on success, 1 on fatal error (invalid profile ID, DB error, disk full, etc.), 2 on partial success (one contributor failed but others completed).

Cron

The default cron job is declared in etc/crontab.xml and runs on schedule 0 2 * * * (02:00 daily):

To change the global schedule, override the job in your project's app/etc/ — or use the per-profile cron_schedule column which takes precedence over the global job's schedule for that single profile.

Confirm the cron is registered and has a recent execution:

Running the queue consumer

When any profile has enable_queue = 1, start the consumer as a long-running process (systemd / supervisord):

The consumer ACKs each shard on success and NACKs + retries on transient errors. Messages that fail three times land on the panth_xml_sitemap.shard.dlq dead-letter topic for manual inspection.

Troubleshooting

/panth-sitemap.xml returns a 404 or a Luma 404 HTML page

You are likely sitting on a stale url_rewrite row left behind by Panth_AdvancedSEO whose target_path still points at the old controller. Run bin/magento setup:upgrade — the RefreshSitemapRewrite patch fires idempotently and rewrites the row to the new target. Follow with bin/magento cache:clean config full_page. Also confirm panth_xml_sitemap/general/enabled = 1 at the store scope being tested — when the master switch is No, the controller returns 404 regardless of url_rewrite state.

Sitemap only contains a handful of URLs

Three causes: (a) the profile has include_products = 0 / include_categories = 0 — flip the toggle and re-run; (b) the delta tracker thinks nothing has changed — run the CLI with --force once to rebuild from scratch; (c) the store's products have visibility = 1 (not visible individually) and are being filtered out as intended — this is correct behaviour for catalog hygiene, not a bug.

Shard files missing from pub/media/panth-sitemap/<store_code>/

The panth-sitemap writable root was never created. Run chmod -R u+w pub/media && mkdir -p pub/media/panth-sitemap && chown -R www-data:www-data pub/media/panth-sitemap, then re-run the CLI. On a containerised deploy ensure the pub/media volume is writable by the PHP-FPM user.

Queue consumer shows "topic not found"

The queue topology hasn't been declared on the AMQP broker. Run bin/magento queue:consumers:start panth_xml_sitemap_consumer --single-thread once — on first connect it declares the panth_xml_sitemap.shard topic, the panth_xml_sitemap_consumer queue, and the binding. You can also run bin/magento setup:upgrade which triggers the declaration via the DI.xml consumer wiring.

Hreflang tags missing from shards despite enable_hreflang = 1

Hreflang only fires when the store has two or more store_view rows with different locale codes. A single-locale store legitimately has no alternates to emit, so the contributor is a no-op. Confirm with SELECT code, locale_code FROM store s JOIN core_config_data c ON c.scope_id = s.store_id WHERE c.path = 'general/locale/code'; — you need at least two distinct locale_code values.

Support

• Agency: Panth Infotech on Upwork
• Direct: kishansavaliya.com — Get a free quote