Skip to content

XML Sitemap & Hreflang — Content Types & Use Cases

Package: @vicacha-devs/strapi-plugin-sitemap · Plugin ID: sitemap · Admin Workspace: /admin/plugins/sitemap

1. Content-Type Entities, Locations & Schemas (strapi.documents)

Section titled “1. Content-Type Entities, Locations & Schemas (strapi.documents)”

Registers two internal Collection Types (plugin::sitemap.sitemap-content-type and plugin::sitemap.sitemap-content-type-single-url) and one Single Type (plugin::sitemap.sitemap-option) with content-manager.visible: false, while introspecting all public api::* and plugin::* Content-Type entities to generate /api/sitemap/sitemap.xml and /api/sitemap/sitemap-{slug}.xml.

Where to Find Content-Type Entities in Strapi v5

Section titled “Where to Find Content-Type Entities in Strapi v5”
  • Settings Panel (4 Tabs): /admin/settings/sitemap (Settings -> Sitemap -> Configuration — organized into General & Sitemap Index, Collection Types, Custom URLs, and Excluded URLs tabs)
  • Internal Persistence Entities: plugin::sitemap.sitemap-content-type (strapi_5_sitemap_plugin_content_types), plugin::sitemap.sitemap-content-type-single-url (strapi_5_sitemap_plugin_content_type_single_urls), and plugin::sitemap.sitemap-option (strapi_5_sitemap_plugin_options)

plugin::sitemap.sitemap-content-type — Sitemap Content Type

Section titled “plugin::sitemap.sitemap-content-type — Sitemap Content Type”

Per-locale URL pattern, priority, and changefreq mapping for a Strapi Content-Type entity

Kind: collectionType · DB Table: strapi_5_sitemap_plugin_content_types · Admin Location: Internal (/admin/plugins/sitemap) · Draft & Publish: No · i18n: No

Attribute Strapi Type Required Constraints / Target
type string No —
langcode string No —
pattern string No —
priority float No —
frequency string No —
lastModified string No —
thumbnail string No —
populateLinkedModels string No —

plugin::sitemap.sitemap-content-type-single-url — Sitemap Single URL

Section titled “plugin::sitemap.sitemap-content-type-single-url — Sitemap Single URL”

Custom static URL entry included alongside dynamic CMS entries in sitemap.xml

Kind: collectionType · DB Table: strapi_5_sitemap_plugin_content_type_single_urls · Admin Location: Internal (/admin/plugins/sitemap) · Draft & Publish: No · i18n: No

Attribute Strapi Type Required Constraints / Target
slug string No —
priority float No —
frequency string No —

plugin::sitemap.sitemap-option — Sitemap Options

Section titled “plugin::sitemap.sitemap-option — Sitemap Options”

Global sitemap configuration (baseUrl, excludedUrls, useSitemapIndex, sitemapDefinitions)

Kind: singleType · DB Table: strapi_5_sitemap_plugin_options · Admin Location: Internal (/admin/plugins/sitemap) · Draft & Publish: No · i18n: No

Attribute Strapi Type Required Constraints / Target
baseUrl string No —
excludedUrls json No default: []
useSitemapIndex boolean No default: false
sitemapDefinitions json No default: []

Strapi v5 Content Manager Integration (/admin/content-manager)

Section titled “Strapi v5 Content Manager Integration (/admin/content-manager)”

Content Manager Sidebar Group: Maps All Public Content Manager Collection Types & Single Types

  • plugin::sitemap.sitemap-content-type (Internal URL pattern mapping for Content Manager entities)
  • plugin::sitemap.sitemap-content-type-single-url (Internal custom static URL entries)
  • plugin::sitemap.sitemap-option (Internal global sitemap settings)

XML Sitemap & Hreflang — Strapi v5 Content Manager Entities & Editorial View

Why This Plugin Creates & Integrates Content Manager Entities

Section titled “Why This Plugin Creates & Integrates Content Manager Entities”

@vicacha-devs/strapi-plugin-sitemap keeps its 3 configuration schemas (sitemap-content-type, sitemap-content-type-single-url, sitemap-option) hidden from the Content Manager sidebar (content-manager.visible: false) to prevent accidental schema edits, while dynamically reading published documents and i18n localizations from every public Content Manager Collection Type (api::* and plugin::*):

  • Automatic Sync with Content Manager Publishing: Whenever an editor publishes, updates, or unpublishes an Article, Event, Donation Campaign, or Resource Publication in Content Manager, /api/sitemap/sitemap.xml automatically reflects its lastmod and xhtml:link hreflang alternates.

How to Use in Strapi Content Manager (Step-by-Step)

Section titled “How to Use in Strapi Content Manager (Step-by-Step)”
  1. Publish Content in Content Manager: Author and publish localized entries in any api::* or plugin::* collection inside /admin/content-manager.
  2. Map URL Patterns in Sitemap Settings: Open /admin/settings/sitemap -> Collection Types tab and bind each Content Manager collection UID + locale to its frontend route pattern (e.g., /[locale]/articles/[slug]).
  3. Configure Sitemap Index, Custom & Excluded URLs: Use the General & Sitemap Index tab (Use sitemap index with multiple sitemaps + getSitemapBySlug in Users & Permissions → Public → Sitemap), Custom URLs tab, and Excluded URLs tab in /admin/settings/sitemap.

Content Manager & Plugin Workspace Synchronization

Section titled “Content Manager & Plugin Workspace Synchronization”

Content Manager Use Cases & Editorial Workflows

Section titled “Content Manager Use Cases & Editorial Workflows”

Content Manager Use Case 1 — Auto-Syndicating Published Content Manager Entries to Multilingual XML Sitemaps

Section titled “Content Manager Use Case 1 — Auto-Syndicating Published Content Manager Entries to Multilingual XML Sitemaps”
  • Why & What it is for: Ensure every newly published localized Event, Article, or Publication in Content Manager is immediately indexed with hreflang alternates.
  • How to use in Content Manager: Publish the entry across es, en, ar, and tr in /admin/content-manager and verify its <url> block in GET /api/sitemap/sitemap.xml.
Section titled “Use Case 1 — Dynamic Multilingual Entity URL Pattern Mapping & xhtml:link Hreflang”
  • What it is for: Map any localized Strapi Content-Type entity (api::article.article, plugin::events.event, plugin::resources.publication) to dynamic URL patterns with automatic hreflang alternates.
  • How it works: In /admin/settings/sitemap (Collection Types tab), map a content type + langcode to a pattern (e.g., /[locale]/articles/[slug]), priority, and frequency (plugin::sitemap.sitemap-content-type).

XML Sitemap & Hreflang — Strapi v5 Admin Workspace

Use Case 2 — Hybrid Static + CMS Sitemap with Custom Single URLs & Excluded Paths

Section titled “Use Case 2 — Hybrid Static + CMS Sitemap with Custom Single URLs & Excluded Paths”
  • What it is for: Include static frontend routes (/es, /es/about-us, /en/about-us) alongside dynamic CMS entries in the same XML sitemap while excluding internal paths (/admin, /api, /404).
  • How it works: Add static route entries in the Custom URLs tab (plugin::sitemap.sitemap-content-type-single-url) and exclude internal routes in the Excluded URLs tab of /admin/settings/sitemap.

XML Sitemap & Hreflang — Strapi v5 Content Manager Entities

Use Case 3 — Multi-File Sitemap Index (sitemap-{slug}.xml) for Large Sites

Section titled “Use Case 3 — Multi-File Sitemap Index (sitemap-{slug}.xml) for Large Sites”
  • What it is for: Split large portals into dedicated sub-sitemaps (e.g., /api/sitemap/sitemap-pages.xml, /api/sitemap/sitemap-editorial-and-library.xml, /api/sitemap/sitemap-events-and-liturgy.xml) referenced by a master <sitemapindex>.
  • How it works: Enable Use sitemap index with multiple sitemaps (useSitemapIndex: true), grant getSitemapBySlug in Users & Permissions → Public → Sitemap, and define sitemapDefinitions in the General & Sitemap Index tab of /admin/settings/sitemap (PUT /sitemap/settings).

XML Sitemap & Hreflang — Strapi v5 Settings Panel