# msm-sitemap

**Repository Path**: mirrors_Automattic/msm-sitemap

## Basic Information

- **Project Name**: msm-sitemap
- **Description**: Comprehensive sitemaps for your WordPress VIP site. Joint collaboration between Metro.co.uk, WordPress VIP, Alley Interactive, Maker Media, 10up, and others.
- **Primary Language**: Unknown
- **License**: GPL-2.0
- **Default Branch**: develop
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-08
- **Last Updated**: 2026-09-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Metro Sitemap

Stable tag: 1.5.6  
Requires at least: 6.4  
Tested up to: 6.9  
Requires PHP: 7.4  
License: GPLv2 or later  
License URI: https://www.gnu.org/licenses/gpl-2.0.html  
Tags: sitemap, xml, seo, performance, multisite  
Contributors: metro, automattic, alleyinteractive, makermedia, 10up, garyj  

High-performance XML sitemaps for large-scale WordPress sites. Built for speed, extensibility, and reliability. Metro Sitemap generates robust, scalable XML sitemaps for WordPress sites of any size. Designed for high-traffic and enterprise environments, it ensures your content is discoverable by search engines without slowing down your site.

## At a Glance

* **Fast, reliable XML sitemaps** for large and small sites
* **Asynchronous generation** avoids timeouts and memory issues
* **Supports custom post types** (see FAQ)
* **Multisite compatible**
* **WP-CLI support** for advanced management
* **Extensible** via hooks and filters ([see developer docs](./DEVELOPERS.md))
* **Admin UI** for stats, manual actions, and cron management
* **Browser-friendly XSL styling** with independent stylesheet endpoints

## Installation

1. Upload the plugin folder to `/wp-content/plugins/` or install via the WordPress admin.
2. Activate the plugin through the 'Plugins' menu in WordPress.
3. (Optional) Visit **Tools > Sitemap** in the admin for stats and manual actions.
4. Sitemaps will be generated automatically in the background.

## Usage

* Your sitemap index will be available at `/sitemap.xml` (e.g., `https://example.com/sitemap.xml`).
* Sitemaps are generated in the background and updated as you publish new content.
* The admin UI (Tools > Sitemap) provides stats and lets you manually trigger generation if needed.

### Automatic Updates

By default, automatic sitemap updates are **disabled** to prevent resource issues on large sites. To enable automatic updates:

**Via Admin UI:**
1. Go to **Tools > Sitemap** in your WordPress admin
2. In the "Cron Management" section, click "Enable Automatic Updates"
3. Once enabled, you can use the "Generate" section to manually trigger sitemap generation

**Via WP-CLI:**
```shell
wp msm-sitemap cron enable
```

**Important:** Automatic updates can use significant resources on sites with many posts. For large sites, consider using date-targeted WP-CLI commands instead (see below).

## Frequently Asked Questions

### Why isn’t my custom post type included in the sitemap?

By default, only the `post` post type is included. To add custom post types (like `page`, `news`, or others), see the [Developer Guide](./DEVELOPERS.md).

### How do I include posts with a custom status?

By default, only published posts are included. You can change this via a filter. See the [Developer Guide](./DEVELOPERS.md).

### How do I regenerate the sitemap?

Sitemaps are generated automatically, but you can:

* Use the admin UI (**Tools > Sitemap**) to trigger a manual rebuild
* Use WP-CLI commands (see below)

### Does it work on multisite?

Yes! Each site in your network will have its own sitemaps. The plugin can be network-activated.

### How do I exclude specific posts or dates?

You can filter which posts or dates appear in the sitemap using hooks—see the [Developer Guide](./DEVELOPERS.md).

### Where is the sitemap stored?

Sitemap XML is stored in a custom post type (`msm_sitemap`) and served on-demand for fast performance.

### Can I customize the number of posts per sitemap?

Yes, this is filterable. See the [Developer Guide](./DEVELOPERS.md).

### How do I disable the XSL styling for sitemaps?

If you want to serve plain XML without browser styling, you can disable the XSL stylesheet references:

```php
add_filter( 'msm_sitemap_include_xsl_reference', '__return_false' );
```

For more XSL customization options, see the [Developer Guide](./DEVELOPERS.md).

## WP-CLI Commands

Metro Sitemap supports advanced management via WP-CLI. Here are the most common commands:

### Core Commands

- **generate**: Generate sitemaps for all or specific dates.
  ```shell
  wp msm-sitemap generate --all
  ```
- **delete**: Delete sitemaps for all or specific dates.
  ```shell
  wp msm-sitemap delete --date=2024-07
  ```
- **list**: List sitemaps.
  ```shell
  wp msm-sitemap list --format=json
  ```
- **get**: Get details for a sitemap by ID or date.
  ```shell
  wp msm-sitemap get 579
  ```
- **validate**: Validate sitemaps for all or specific dates.
  ```shell
  wp msm-sitemap validate --all
  ```
- **export**: Export sitemaps to a directory.
  ```shell
  wp msm-sitemap export --all --output=/tmp
  ```
- **recount**: Recalculate and update the indexed URL count for all sitemap posts.
  ```shell
  wp msm-sitemap recount
  ```
- **stats**: Show sitemap statistics (total, most recent, etc).
  ```shell
  wp msm-sitemap stats --format=table
  ```

### Cron Management Commands

- **cron enable**: Enable automatic sitemap updates.
  ```shell
  wp msm-sitemap cron enable
  ```
- **cron disable**: Disable automatic sitemap updates.
  ```shell
  wp msm-sitemap cron disable
  ```
- **cron status**: Check the status of automatic updates.
  ```shell
  wp msm-sitemap cron status
  ```
- **cron reset**: Reset cron to clean state (for testing).
  ```shell
  wp msm-sitemap cron reset
  ```

For the full list of commands, options, and legacy command mapping, see [DEVELOPERS.md](./DEVELOPERS.md).

## Support

* [GitHub Issues](https://github.com/Automattic/msm-sitemap/issues) (for bug reports and feature requests)
* [WordPress VIP Support](https://wpvip.com/wordpress-vip-enterprise-support/) (for WPVIP customers)

## Credits

Metro Sitemap is a joint collaboration between Metro.co.uk, WordPress VIP, Alley Interactive, Maker Media, 10up, and others. Special thanks to all contributors.

## Changelog

See [CHANGELOG.md](./CHANGELOG.md) for a full history of changes.

## License

GPLv2 or later. See [LICENSE](./LICENSE) for details.

## Developer Documentation

For advanced customization, see [DEVELOPERS.md](./DEVELOPERS.md).