# magefan/module-html-sitemap

> HTML Sitemap extension for Magento 2

`composer require magefan/module-html-sitemap`

Canonical URL: https://packagento.com/magefan/module-html-sitemap

## At a glance

- **Vendor**: magefan (https://packagento.com/magefan.md)
- **Latest version**: 2.3.0 — released 2025-02-28
- **Pricing**: Free
- **Package type**: Magento 2 module
- **Status**: active, accepting new buyers

## Installation

Packagento is licence-gated, so even free packages need a licence on a project before Composer can resolve them.

1. **Sign in or create an account** at https://packagento.com/customer/account/.

2. **Add the package to your account.** Open https://packagento.com/magefan/module-html-sitemap and complete the free checkout. A licence is minted automatically.

3. **Create or pick a project, then activate the licence on it.**
   - Projects represent the Magento installs you deploy to. Manage them at https://packagento.com/projects/.
   - Activate the new licence on the project you'll deploy this package to. Activation is what generates the Composer credentials scoped to that project.

4. **Add the project credentials to your Magento codebase.**

   Grab the project's public + private key from https://packagento.com/projects/ (open the project, then its Credentials tab), and add them to `auth.json`:

   ```json
   {
     "http-basic": {
       "packagento.com": {
         "username": "ppk_live_...",
         "password": "psk_live_..."
       }
     }
   }
   ```

   Add the Packagento Composer repository to `composer.json`:

   ```json
   {
     "repositories": [
       { "type": "composer", "url": "https://packagento.com" }
     ]
   }
   ```

5. **Install and apply.**

   ```bash
   composer require magefan/module-html-sitemap:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## What it does

HTML Sitemap extension for Magento 2

## README


[![Total Downloads](https://poser.pugx.org/magefan/module-html-sitemap/downloads)](https://packagist.org/packages/magefan/module-html-sitemap)
[![Latest Stable Version](https://poser.pugx.org/magefan/module-html-sitemap/v/stable)](https://packagist.org/packages/magefan/module-html-sitemap)

<a href="https://savelife.in.ua/en/donate-en/#donate-army-card-monthly"><img width="830" height="208" src="https://cm.magefan.com/blog/support-ukraine.png"></a>

<img width="150" height="100" src="https://magefan.com/media/wysiwyg/made_in_ukraine.jpg">

<img align="right" width="120" height="120" src="https://cm.magefan.com/mf_webp/jpg/media/catalog/product/cache/103e1b2520de2a36a364b0391bff6bdc/i/c/icon-sitemap.webp">

[Magento 2 HTML Sitemap Extension Free](https://magefan.com/magento-2-html-sitemap-extension) is a solution that helps you to generate a unique HTML sitemap for your store and gather all of your store pages links in one place. It improves website navigation and makes indexing faster and easier.

<a href="https://magefan.com/magento-2-html-sitemap-extension"><img width="190" height="70" src="https://cm.magefan.com/wysiwyg/products/download-magefan-extensions.png"></a><a href="https://magefan.com/magento-2-html-sitemap-extension#live-demo"><img width="190" height="70" src="https://cm.magefan.com/wysiwyg/products/magefan-live-demo.png"></a><a href="https://magefan.com/magento-2-seo-extension"><img width="190" height="70" src="https://cm.magefan.com/wysiwyg/products/magefan-seo.png"></a>

### Requirements
  * Magento Community 2.3.0-2.4.x (CE, EE, ECE, B2B)
  * [Magefan Community Extension](https://github.com/magefan/module-community) >= v2.1.20. Please install this extension first if you use installation via FTP.
  * **Note** that the extension is free only for the Magento Community (Open Source) Edition. For Magento EE, ECE, and B2B you need to purchase the license  at magefan.com.

### Benefits

* Faster website indexation
* Improved store navigation
* Better customer experience

### Features
#### Unique HTML Sitemap Page

If customers don’t find what they’re looking for they leave your website with no promise of coming back. This proves that search and website navigation is important for your business and customer satisfaction. Magento 2 HTML Sitemap extension allows you to generate a unique HTM sitemap page with all of the links to different store pages: products, categories, CMS pages or any other pages on your store.  It not only improves navigation for customers but makes it easier for search crawlers to understand the structure of your store.

<p align="center">
  <img width="860" height="428" src="https://cm.magefan.com/mf_webp/png/media/catalog/magento-seo-sitemap_1.webp">
</p>

#### Exclude Pages from HTML Sitemap

Not all pages of your store are equally “popular” or visited. Some are not predetermined to be visited. To hide those pages from sitemap, HTML Sitemap Extension for Magento offers you the “Exclude” or “Hide” options. You just need to enter the links of the pages you don’t want to add to the sitemap and people won’t be able to navigate them from the HTML Sitemap storefront page.

<p align="center">
  <img width="860" height="428" src="https://cm.magefan.com/mf_webp/png/media/catalog/exclude-pages-from-html-sitemap_1.webp">
</p>

#### HTML Sitemap Block Sorting Order

To define more important pages (so they can be indexed and crawled faster), you can set the sort order for the page blocks. With the Magento 2 HTML Sitemap Extension, you can set product or category pages to be displayed at the top of the HTML Sitemap, and the other of them lower down the page correspondingly. It is up to you to specify what is more important to your customers.

<p align="center">
  <img width="860" height="428" src="https://cm.magefan.com/mf_webp/png/media/catalog/html-sitemap-blocks-sort-order_1.webp">
</p>

#### Sitemap Search Engine Optimization

Since the HTML Sitemap page is displayed on the storefront as any other page of your store, it needs a meta title and description. It helps your store visitors, customers, and search engines better understand what the page is about.

<p align="center">
  <img width="860" height="428" src="https://cm.magefan.com/mf_webp/png/media/catalog/html-sitemap-page-metadata_1.webp">
</p>

### Demo

Try out our open demo and if you like our extension **please give us some star on Github ★**
<table>
  <tbody>
    <tr>
      <td align="center" valign="middle">
        Storefront Demo
      </td>
      <td align="center" valign="middle">
        Admin Panel Demo
      </td align="center" valign="middle">
    </tr>
    <tr>
      <td align="center" valign="middle">
        <a href="https://seo.demo.magefan.top/htmlsitemap">
          <img
            src="https://magefan.com/static/version1520969775/frontend/Magefan/new/en_US/images/product-tab-demo-1.jpg"
            alt="Magneto 2 HTML Extension Storefront Demo"
            height="220"
          >
        </a>
      </td>
      <td align="center" valign="middle">
        <a href="https://seo.demo.magefan.top/admin/admin/system_config/edit/section/mfhs/">
          <img
            src="https://magefan.com/static/version1520969775/frontend/Magefan/new/en_US/images/product-tab-demo-2.jpg"
            alt="Magneto 2 HTML Extension Admin Panel Demo"
            height="220"
          >
        </a>
      </td>
    </tr>
    <tr>
      <td align="center" valign="middle">
        <a href="https://seo.demo.magefan.top/htmlsitemap">
          view
        </a>
      </td>
      <td align="center" valign="middle">
        <a href="https://seo.demo.magefan.top/admin/admin/system_config/edit/section/mfhs/">
          view
        </a>
      </td>
    </tr>
  </tbody>
</table>

### Support
If you have any issues, please [contact us](mailto:support@magefan.com)
then if you still need help,

_(README truncated for .md surface. Full README on https://packagento.com/magefan/module-html-sitemap.)_

## Recent Versions

| Version | Released |
|---|---|
| 2.3.0 | 2025-02-28 |
| 2.2.3 | 2024-09-23 |
| 2.2.2 | 2024-06-17 |
| 2.2.1 | 2024-05-23 |
| 2.2.0 | 2024-05-20 |
| 2.1.3 | 2023-10-17 |
| 2.1.2 | 2023-10-12 |
| 2.1.1 | 2023-05-01 |
| 2.1.0 | 2023-02-24 |
| 2.0.5 | 2022-11-23 |

Showing 10 of 15 versions. Full release history on https://packagento.com/magefan/module-html-sitemap.

## Dependencies

### Require

| Package | Constraint |
|---|---|
| magefan/module-community | >=2.2.7 |

## Quality

Latest release (2.3.0) fails the Packagento QA pipeline. Verdicts below are per-cell (Magento line × PHP version) for the matrixed tools, and run-once for the static / security tiers.


### Compatibility

Each Magento line is installed on its supported PHP versions, then the module is built (DI compile + static-content deploy). Cells show passed / failed / untested; staircase gaps render as `–`.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | Pass | Pass | – | – |
| 2.4.8 | – | Pass | 1 | – |
| 2.4.9 | – | – | 1 | 1 |


### Code Quality

Advisory checks against the module's source. Never affect the Compatibility verdict — a phpcs finding can't make a module incompatible.

#### Static Analysis

Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| PHPCS | Fail | 25 | 3 errors, 22 warnings (ruleset: Magento2) |
| PHPMD | Warning | 18 | 18 rule violations (IfStatementAssignment:13, UnusedFormalParameter:4, UnusedLocalVariable:1) |
| Cpd | Pass | 0 |  |
| Composer validate | Info | 2 | valid; 2 advisory notes (composer validate --strict) |

#### PHPStan

Type-checks the module against a real Magento install. Re-runs per Magento + PHP version because resolvable symbols differ between releases.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | 50 | 50 | – | – |
| 2.4.8 | – | 59 | 59 | – |
| 2.4.9 | – | – | 59 | 59 |


### Tests

Unit and integration suites run per Magento + PHP cell. Test failures speak to the module's behaviour, not its compatibility with a line, so they're reported here separately.

#### Unit Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |

#### Integration Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |


### Security

Dependency-advisory audit (composer audit) plus a source malware scan. A malware detection fails the version outright.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| Composer audit | Pass | 0 |  |
| Malware scan | Pass | 0 |  |

## Licence and pricing

Free. A licence is still minted on checkout and bound to your project for Composer access — no payment step.

Refundable within 14 days of first purchase via https://packagento.com/account/refunds/.

## Install via Claude Code or any MCP client

The Packagento MCP server can run the licence + project + Composer steps above in one tool call:

```
purchase_and_install_packages(
  composer_names=["magefan/module-html-sitemap"],
  project_id="proj_xxx"
)
```

This handles cart, checkout, licence minting, project activation, and writes auth.json credentials. Connect a client with `claude mcp add packagento https://mcp.packagento.com`. Full setup at https://packagento.com/docs/mcp-setup.

## Vendor

magefan is a Magento 2 vendor on Packagento. See https://packagento.com/magefan.md for their full catalogue.