PHPackages rumenx/php-sitemap - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Parsing & Serialization](/categories/parsing) 4. / 5. rumenx/php-sitemap ActiveLibrary[Parsing & Serialization](/categories/parsing) rumenx/php-sitemap ================== Framework-agnostic Sitemap generator for PHP, Laravel, and Symfony. v1.0.2(5mo ago)1.3k15.1kโ†‘39%275[1 issues](https://github.com/RumenDamyanov/php-sitemap/issues)1MITPHPPHP >=8.2CI passing Since Sep 12Pushed 2mo ago36 watchersCompare [ Source](https://github.com/RumenDamyanov/php-sitemap)[ Packagist](https://packagist.org/packages/rumenx/php-sitemap)[ Docs](https://github.com/RumenDamyanov/php-sitemap)[ GitHub Sponsors](https://github.com/sponsors/RumenDamyanov)[ RSS](/packages/rumenx-php-sitemap/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (2)Dependencies (6)Versions (7)Used By (1) **[php-sitemap](https://github.com/RumenDamyanov/php-sitemap) package** ======================================================================= [](#php-sitemap-package) [![CI](https://github.com/RumenDamyanov/php-sitemap/actions/workflows/ci.yml/badge.svg)](https://github.com/RumenDamyanov/php-sitemap/actions/workflows/ci.yml)[![Analyze](https://github.com/RumenDamyanov/php-sitemap/actions/workflows/analyze.yml/badge.svg)](https://github.com/RumenDamyanov/php-sitemap/actions/workflows/analyze.yml)[![Style](https://github.com/RumenDamyanov/php-sitemap/actions/workflows/style.yml/badge.svg)](https://github.com/RumenDamyanov/php-sitemap/actions/workflows/style.yml)[![CodeQL](https://github.com/RumenDamyanov/php-sitemap/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/RumenDamyanov/php-sitemap/actions/workflows/github-code-scanning/codeql)[![Dependabot](https://github.com/RumenDamyanov/php-sitemap/actions/workflows/dependabot/dependabot-updates/badge.svg)](https://github.com/RumenDamyanov/php-sitemap/actions/workflows/dependabot/dependabot-updates)[![codecov](https://camo.githubusercontent.com/a8f9538ad1da95967469e0677aa76fa78132d463f54d24fe426f32bd13e796f1/68747470733a2f2f636f6465636f762e696f2f67682f52756d656e44616d79616e6f762f7068702d736974656d61702f6272616e63682f6d61737465722f67726170682f62616467652e737667)](https://codecov.io/gh/RumenDamyanov/php-sitemap) **php-sitemap** is a modern, framework-agnostic PHP package for generating sitemaps in XML, TXT, HTML, and Google News formats. It works seamlessly with Laravel, Symfony, or any PHP project. Features include high test coverage, robust CI, extensible adapters, and support for images, videos, translations, alternates, and Google News. --- ๐Ÿ“ฆ Part of the Sitemap Family ---------------------------- [](#-part-of-the-sitemap-family) This is the PHP implementation of our multi-language sitemap library: - ๐Ÿ˜ **[php-sitemap](https://github.com/RumenDamyanov/php-sitemap)** - PHP 8.2+ implementation with Laravel & Symfony support (this package) - ๐Ÿ“˜ **[npm-sitemap](https://github.com/RumenDamyanov/npm-sitemap)** - TypeScript/JavaScript implementation for Node.js and frontend frameworks - ๐Ÿ”ท **[go-sitemap](https://github.com/RumenDamyanov/go-sitemap)** - Go implementation for high-performance applications All implementations share the same API design and features, making it easy to switch between languages or maintain consistency across polyglot projects. ๐Ÿ”— Recommended Projects ---------------------- [](#-recommended-projects) If you find **php-sitemap** useful, you might also be interested in these related projects: - ๐Ÿ” **[php-seo](https://github.com/RumenDamyanov/php-seo)** - Comprehensive SEO toolkit for meta tags, structured data, and search optimization - ๐Ÿค– **[php-chatbot](https://github.com/RumenDamyanov/php-chatbot)** - Conversational AI and chatbot framework for PHP applications - ๐Ÿ“ฐ **[php-feed](https://github.com/RumenDamyanov/php-feed)** - RSS, Atom, and JSON feed generator for content syndication - ๐ŸŒ **[php-geolocation](https://github.com/RumenDamyanov/php-geolocation)** - IP geolocation, geocoding, and geographic data utilities --- โœจ Features ---------- [](#-features) - **Framework-agnostic**: Use in Laravel, Symfony, or any PHP project - **Multiple formats**: XML, TXT, HTML, Google News, mobile - **Rich content**: Supports images, videos, translations, alternates, Google News - **Modern PHP**: Type-safe, extensible, and robust (PHP 8.2+) - **High test coverage**: 100% code coverage, CI/CD ready - **Easy integration**: Simple API, drop-in for controllers/routes - **Extensible**: Adapters for Laravel, Symfony, and more - **Quality tools**: PHPStan Level max, PSR-12, comprehensive testing - **Input validation**: Built-in URL, priority, and frequency validation - **Type-safe configuration**: Fluent configuration with `SitemapConfig` class - **Fluent interface**: Method chaining for elegant, readable code --- ๐Ÿ”— Quick Links ------------- [](#-quick-links) - ๐Ÿ“– [Installation](#installation) - ๐Ÿš€ [Usage Examples](#usage) - ๐Ÿงช [Testing & Development](#testing--development) - ๐Ÿค [Contributing](CONTRIBUTING.md) - ๐Ÿ”’ [Security Policy](SECURITY.md) - ๐Ÿ’ [Support & Funding](FUNDING.md) - ๐Ÿ“„ [License](#license) --- ๐Ÿ“ฆ Installation -------------- [](#-installation) ### Requirements [](#requirements) - **PHP 8.2+** - **Composer** ### Install via Composer [](#install-via-composer) ``` composer require rumenx/php-sitemap ``` No additional configuration required! The package works out of the box. --- ๐Ÿš€ Usage ------- [](#-usage) ### Laravel Example [](#laravel-example) **Controller method:** ``` use Rumenx\Sitemap\Sitemap; public function sitemap(Sitemap $sitemap) { $sitemap->add('https://example.com/', now(), '1.0', 'daily'); $sitemap->add('https://example.com/about', now(), '0.8', 'monthly', images: [ ['url' => 'https://example.com/img/about.jpg', 'title' => 'About Us'] ]); // Add more items as needed... // Render XML using a view template $items = $sitemap->getModel()->getItems(); return response()->view('sitemap.xml', compact('items'), 200, ['Content-Type' => 'application/xml']); } ``` **Route registration:** ``` Route::get('/sitemap.xml', [SitemapController::class, 'sitemap']); ``` **Advanced:** ``` // Add with translations, videos, alternates, Google News $sitemap->add( 'https://example.com/news', now(), '0.7', 'weekly', images: [['url' => 'https://example.com/img/news.jpg', 'title' => 'News Image']], title: 'News Article', translations: [['language' => 'fr', 'url' => 'https://example.com/fr/news']], videos: [['title' => 'News Video', 'description' => 'Video description']], googlenews: [ 'sitename' => 'Example News', 'language' => 'en', 'publication_date' => now(), ], alternates: [['media' => 'print', 'url' => 'https://example.com/news-print']] ); ``` --- ### Symfony Example [](#symfony-example) **Controller:** ``` use Rumenx\Sitemap\Sitemap; use Symfony\Component\HttpFoundation\Response; class SitemapController { public function sitemap(): Response { $sitemap = new Sitemap(); $sitemap->add('https://example.com/', (new \DateTime())->format(DATE_ATOM), '1.0', 'daily'); $sitemap->add('https://example.com/contact', (new \DateTime())->format(DATE_ATOM), '0.5', 'monthly'); // Add more items as needed... // Render XML $xml = $sitemap->renderXml(); return new Response($xml, 200, ['Content-Type' => 'application/xml']); } } ``` **Route registration:** ``` # config/routes.yaml sitemap: path: /sitemap.xml controller: App\Controller\SitemapController::sitemap ``` --- ### Generic PHP Example [](#generic-php-example) ``` require 'vendor/autoload.php'; use Rumenx\Sitemap\Sitemap; $sitemap = new Sitemap(); $sitemap->add('https://example.com/', date('c'), '1.0', 'daily'); $sitemap->add( 'https://example.com/products', date('c'), '0.9', 'weekly', images: [['url' => 'https://example.com/img/product.jpg', 'title' => 'Product Image']] ); // Output XML header('Content-Type: application/xml'); echo $sitemap->renderXml(); ``` --- ### Advanced Features [](#advanced-features) ``` // Add with all supported fields $sitemap->add( 'https://example.com/news', date('c'), '0.8', 'daily', images: [['url' => 'https://example.com/img/news.jpg', 'title' => 'News Image']], title: 'News Article', translations: [['language' => 'fr', 'url' => 'https://example.com/fr/news']], videos: [['title' => 'News Video', 'description' => 'Video description']], googlenews: [ 'sitename' => 'Example News', 'language' => 'en', 'publication_date' => date('c'), ], alternates: [['media' => 'print', 'url' => 'https://example.com/news-print']] ); // Generate XML using renderXml() method $xml = $sitemap->renderXml(); file_put_contents('sitemap.xml', $xml); // Or use view templates for more control (create your own views based on src/views/) $items = $sitemap->getModel()->getItems(); // Pass $items to your view template ``` --- ### add() vs addItem() [](#add-vs-additem) You can add sitemap entries using either the `add()` or `addItem()` methods: **add() โ€” Simple, type-safe, one-at-a-time:** ``` // Recommended for most use cases $sitemap->add( 'https://example.com/', date('c'), '1.0', 'daily', images: [['url' => 'https://example.com/img.jpg', 'title' => 'Image']], title: 'Homepage' ); ``` **addItem() โ€” Advanced, array-based, supports batch:** ``` // Add a single item with an array (all fields as keys) $sitemap->addItem([ 'loc' => 'https://example.com/about', 'lastmod' => date('c'), 'priority' => '0.8', 'freq' => 'monthly', 'title' => 'About Us', 'images' => [['url' => 'https://example.com/img/about.jpg', 'title' => 'About Us']], ]); // Add multiple items at once (batch add) $sitemap->addItem([ [ 'loc' => 'https://example.com/page1', 'title' => 'Page 1', ], [ 'loc' => 'https://example.com/page2', 'title' => 'Page 2', ], ]); ``` - Use `add()` for simple, explicit, one-at-a-time additions (recommended for most users). - Use `addItem()` for advanced, batch, or programmatic additions with arrays (e.g., when looping over database results). --- ๐Ÿ”ง New Features -------------- [](#-new-features) ### Fluent Interface (Method Chaining) [](#fluent-interface-method-chaining) Chain methods for more elegant and readable code: ``` $sitemap = (new Sitemap()) ->add('https://example.com/', date('c'), '1.0', 'daily') ->add('https://example.com/about', date('c'), '0.8', 'monthly') ->add('https://example.com/contact', date('c'), '0.6', 'yearly') ->store('xml', 'sitemap', './public'); ``` ### Type-Safe Configuration [](#type-safe-configuration) Configure sitemaps with a fluent, type-safe configuration class: ``` use Rumenx\Sitemap\Config\SitemapConfig; $config = (new SitemapConfig()) ->setEscaping(true) ->setStrictMode(true) ->setUseGzip(true) ->setDefaultFormat('xml'); $sitemap = new Sitemap($config); ``` ### Input Validation [](#input-validation) Enable strict mode to automatically validate all input: ``` $config = new SitemapConfig(strictMode: true); $sitemap = new Sitemap($config); // Valid data works fine $sitemap->add('https://example.com', '2023-12-01', '0.8', 'daily'); // Invalid data throws InvalidArgumentException try { $sitemap->add('not-a-url', '2023-12-01', '2.0', 'sometimes'); } catch (\InvalidArgumentException $e) { echo "Validation error: " . $e->getMessage(); } ``` ### Multiple Format Support [](#multiple-format-support) Render sitemaps in different formats: ``` $sitemap = new Sitemap(); $sitemap->add('https://example.com/', date('c'), '1.0', 'daily'); // Render as XML $xml = $sitemap->render('xml'); // Render as HTML $html = $sitemap->render('html'); // Render as plain text $txt = $sitemap->render('txt'); // Save to file $sitemap->store('xml', 'sitemap', './public'); ``` --- ๐ŸŽจ Rendering Options ------------------- [](#-rendering-options) The package provides multiple ways to generate sitemap output: ### 1. Built-in XML Renderer (Simple) [](#1-built-in-xml-renderer-simple) ``` $sitemap = new Sitemap(); $sitemap->add('https://example.com/', date('c'), '1.0', 'daily'); $xml = $sitemap->renderXml(); // Returns XML string ``` ### 2. View Templates (Flexible) [](#2-view-templates-flexible) For more control, use the included view templates or create your own: ``` $sitemap = new Sitemap(); $sitemap->add('https://example.com/', date('c'), '1.0', 'daily'); // Get the data for your view $items = $sitemap->getModel()->getItems(); // Laravel: Use response()->view() or view()->render() return response()->view('sitemap.xml', compact('items'), 200, ['Content-Type' => 'application/xml']); // Symfony: Use Twig templates return $this->render('sitemap.xml.twig', ['items' => $items], new Response('', 200, ['Content-Type' => 'application/xml'])); // Generic PHP: Include view templates ob_start(); include 'vendor/rumenx/php-sitemap/src/views/xml.php'; $xml = ob_get_clean(); ``` **Available view templates** in `src/views/`: - `xml.php` - Standard XML sitemap - `xml-mobile.php` - Mobile-specific sitemap - `google-news.php` - Google News sitemap - `sitemapindex.php` - Sitemap index - `txt.php` - Plain text format - `html.php` - HTML format --- ๐Ÿงช Testing & Development --------------------------- [](#-testing--development) ### Running Tests [](#running-tests) ``` # Run all tests composer test # Run tests with text coverage report composer coverage # Generate full HTML coverage report composer coverage-html ``` ### Code Quality [](#code-quality) ``` # Run static analysis (PHPStan Level 6) composer analyze # Check coding standards (PSR-12) composer style # Auto-fix coding standards composer style-fix ``` ### Manual Testing [](#manual-testing) ``` # Run specific test file ./vendor/bin/pest tests/Unit/SitemapTest.php # Run tests in watch mode ./vendor/bin/pest --watch ``` --- ๐Ÿค Contributing -------------- [](#-contributing) We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details on: - Development setup - Coding standards - Testing requirements - Pull request process --- ๐Ÿ”’ Security ---------- [](#-security) If you discover a security vulnerability, please review our [Security Policy](SECURITY.md) for responsible disclosure guidelines. --- ๐Ÿ’ Support --------- [](#-support) If you find this package helpful, consider: - โญ Starring the repository - ๐Ÿ’ [Supporting development](FUNDING.md) - ๐Ÿ› [Reporting issues](https://github.com/RumenDamyanov/php-sitemap/issues) - ๐Ÿค [Contributing improvements](CONTRIBUTING.md) --- ๐Ÿ“„ License --------- [](#-license) [MIT License](LICENSE.md) ### Health Score 62 โ€” FairBetter than 99% of packages Maintenance80 Actively maintained with recent releases Popularity55 Moderate usage in the ecosystem Community26 Small or concentrated contributor base Maturity71 Established project with proven stability Bus Factor1 Top contributor holds 66.7% of commits โ€” single point of failure How is this calculated?**Maintenance (25%)** โ€” Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** โ€” Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** โ€” Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** โ€” Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~69 days Total 3 Last Release 156d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/48dce3e6200e787e75a4a14e0d31738d112261fe0877f15f74d3fb2c2a626229?d=identicon)[RumenX](/maintainers/RumenX) --- Top Contributors [![RumenDamyanov](https://avatars.githubusercontent.com/u/1458253?v=4)](https://github.com/RumenDamyanov "RumenDamyanov (14 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (7 commits)") --- Tags laravelphpsitemap-generatorsitemap-xmlsitemapindexsymfonyphpsymfonylaravelxmlgeneratorhtmlSitemapgoogle-news ### Code Quality TestsPest Static AnalysisPHPStan Code StylePHP\_CodeSniffer Type Coverage Yes ### Embed Badge ![Health badge](/badges/rumenx-php-sitemap/health.svg) ``` [![Health](https://phpackages.com/badges/rumenx-php-sitemap/health.svg)](https://phpackages.com/packages/rumenx-php-sitemap) ``` ### Alternatives [ultrono/laravel-sitemap Sitemap generator for Laravel 11, 12 and 13 36412.6k6](/packages/ultrono-laravel-sitemap) PHPackages ยฉ 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)