Sitemap Plugin

Abstract

1. Introduction

Goes out to the Sylius team. The core code of this plugin is created by the Sylius team. Unfortunately it got removed from the Sylius core. Luckily the Sylius team approved the extraction to a separate bundle.

2. Objective

Sitemap Plugin for Sylius eCommerce platform

This project demonstrates how PHP can be applied to a real-world Digital Marketing & SEO problem.

3. Key Features / Modules

• Creates a sitemap index file to point to sub sitemap files per type of data
• Default providers: taxons, products & static content (homepage & contact)
• Easily add your own providers
• Product provider supports locales (hreflang) & is channel aware
• Taxon provider supports locales (hreflang)
• providers: Enable/disable certain providers to be included in the sitemap. Defaults are true.
• exclude_taxon_root: Often you don't want to include the root of your taxon tree as it has a generic name as 'products'.
• hreflang: Whether to generate alternative URL versions for each locale. Defaults to true. Background: https://support.google.com/webmasters/answer/189077?hl=en.
• images: Whether to add images to URL output in case the provider adds them. Defaults to true. Background: https://support.google.com/webmasters/answer/178636?hl=en.

4. Technology Stack

5. System Requirements

General requirements for this technology stack — check the README for exact versions.

• PHP 7.4+ with a web server (XAMPP / WAMP / LAMP)
• MySQL / MariaDB
• phpMyAdmin (optional)
• Git (to clone the repository)

6. Installation & Setup

git clone https://github.com/stefandoorn/sitemap-plugin.git
cd sitemap-plugin

1. Run composer require stefandoorn/sitemap-plugin.
2. Add to app/config/bundles.php:
3. Add to app/config/packages/_sylius.yaml:
4. { resource: "@SitemapPlugin/Resources/config/config.yaml" }
5. Add to app/config/routes.yaml:
6. Add to app/config/packages/sylius_sitemap.yaml:
7. Default configuration
8. Forcing HTTPS on Generated URLs, see Symfony Docu. In console commands, where there is no HTTP request, URLs use http by default. You can change this globally with these configuration parameters:

SitemapPlugin\SitemapPlugin::class => ['all' => true],

- { resource: "@SitemapPlugin/Resources/config/config.yaml" }

sylius_sitemap:
    resource: "@SitemapPlugin/Resources/config/routing.yml"

# config/services.yaml
parameters:
    router.request_context.scheme: 'https'

Full setup instructions are in the project README.

7. Future Enhancements

Suggested extensions you can add to make this your own project.

• Export reports to Google Sheets or PDF
• Schedule weekly automated reports
• Add competitor comparison

8. Viva / Review Questions

Common questions examiners ask for projects in this domain.

1. Which marketing or SEO problem does this tool solve?
2. Which data sources or APIs does it use (Search Console, Analytics, social platforms)?
3. Which metrics or KPIs does it report and how are they calculated?
4. How could the output help a business make decisions?
5. How would you schedule it to run automatically?

9. Source Code & License

This project is developed by stefandoorn and published on GitHub under the MIT License. Please follow the license terms and credit the original author when you use or modify this code.