# magefan/module-xml-sitemap

> Magefan XML Sitemap for Magento 2

`composer require magefan/module-xml-sitemap`

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

## At a glance

- **Vendor**: magefan (https://packagento.com/magefan.md)
- **Latest version**: 2.1.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-xml-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-xml-sitemap:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## What it does

Magefan XML Sitemap for Magento 2

## README


[![Total Downloads](https://poser.pugx.org/magefan/module-xml-sitemap/downloads)](https://packagist.org/packages/magefan/module-xml-sitemap)
[![Latest Stable Version](https://poser.pugx.org/magefan/module-xml-sitemap/v/stable)](https://packagist.org/packages/magefan/module-xml-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/catalog/product/cache/103e1b2520de2a36a364b0391bff6bdc/i/c/icon-sitemap-xml.jpg">

[Magento 2 XML Sitemap Extension Free](https://magefan.com/magento-2-xml-sitemap-extension) is a solution that allows you to improve website indexing and communicate your website structure to web crawlers easier. An XML sitemap helps to get new pages of your website discovered, indexed, and pulled out in search much faster. 

Configure automatic XML sitemap generation, set frequency and priority, define XML sitemap file limit, and exclude paged from sitemap easier.

<a href="https://magefan.com/magento-2-xml-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-xml-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

* Better website SEO profile
* Faster website pages indexing
* Automatic XML sitemap generation

### Features

There are a lot of things that influence your website SEO which you can see as metadata, website content, keywords, etc. Still, the most important SEO-related features are always hidden.  

#### Faster Website Indexing

Magento XML sitemap is a machine-readable file in an extensive markup language that is used by search crawlers to navigate your website. It also helps search robots to discover new and updated content so it could be displayed to searchers in search results. 

With the Magento 2 XML Sitemap extension, you’ll be able to generate XML sitemap files manually or automatically and set up frequency and priority for link group indexing. This way all of the new pages you publish will appear in Google faster.

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

#### Automatic Sitemap Generation and Indexing 

Search crawlers regularly scan and index your website to discover new content to publish in search. So you have to update your sitemap as often as you create a new product, category, or CMS page.  

To avoid the hassle, you can enable automatic sitemap generation and configure how often and in what order should the link groups be indexed. It helps you to automate the process and make sure new convent is discovered regularly.

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

#### Exclude Pages from XML Sitemap

Also, the Magento XML sitemap usually contains all of your product, category, and CMS page links so search robots can understand your website structure and page relations better. However, there might be pages that don’t have any SEO potential or value to customers, hence don’t have to be indexed. 

This XML Sitemap Generator for Magento 2 enables you to exclude any product, category, CMS or blog pages from your XML sitemap in just 1 click.

<p align="center">
  <img width="860" height="428" src="https://cm.magefan.com/mf_webp/png/media/catalog/exclude-images-from-xml-sitemap.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/sitemap.xml">
          <img
            src="https://magefan.com/static/version1520969775/frontend/Magefan/new/en_US/images/product-tab-demo-1.jpg"
            alt="Magneto 2 XML 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/mfxmlsitemap/">
          <img
            src="https://magefan.com/static/version1520969775/frontend/Magefan/new/en_US/images/product-tab-demo-2.jpg"
            alt="Magneto 2 XML Extension Admin Panel Demo"
            height="220"
          >
        </a>
      </td>
    </tr>
    <tr>
      <td align="center" valign="middle">
        <a href="https://seo.demo.magefan.top/sitemap.xml">
          view
        </a>
      </td>
      <td align="center" valign="middle">
        <a href="https://seo.demo.magefan.top/admin/admin/system_config/edit/section/mfxmlsitemap/">
          view
        </a>
      </td>
    </tr>
  </tbody>
</table>

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

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

## Recent Versions

| Version | Released |
|---|---|
| 2.1.0 | 2025-02-28 |
| 2.0.2 | 2024-05-23 |
| 2.0.1 | 2024-02-12 |
| 2.0.0 | 2022-07-27 |

## Dependencies

### Require

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

## Quality

Latest release (2.1.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 | Pass | – |
| 2.4.9 | – | – | Pass | Pass |


### 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 | Warning | 11 | 11 warnings (ruleset: Magento2) |
| PHPMD | Warning | 19 | 19 rule violations (UnusedFormalParameter:15, UnusedLocalVariable:3, CyclomaticComplexity:1) |
| Cpd | Pass | 0 |  |
| Composer validate | Info | 3 | valid; 3 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-xml-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.