Skip to content
Lightweight library for generating Google sitemap XML files
Branch: master
Clone or download
Pull request Compare This branch is 22 commits ahead, 1 commit behind o:master.
Latest commit 6511de1 Apr 4, 2019
Type Name Latest commit message Commit time
Failed to load latest commit information.
src/SitemapPHP Update Sitemap.php Feb 2, 2016
ChangeLog Updated changelog. Prepare for release. Apr 17, 2015
LICENSE Added my own copyright, and changed link to my repository. Apr 17, 2015 Update Apr 4, 2019
composer.json Fixed homepage url. Jul 6, 2015


Fast and lightweight class for generating Google sitemap XML files and index of sitemap files. Written on PHP and uses XMLWriter extension (wrapper for libxml xmlWriter API) for creating XML files. XMLWriter extension is enabled by default in PHP 5 >= 5.1.2. If you having more than 50000 url, it splits items to seperated files. (In benchmarks, 1.000.000 url was generating in 8 seconds)

This is a slightly modified version of the original. The Sitemap class is now added to a 'SitemapPHP' namespace, and a composer document has been added.


  • PHP 5.1.2 and above




Run the following command to include this package via Composer

composer require evert/sitemap-php


Include Sitemap.php file to your PHP document and call Sitemap class with your base domain.

	include 'src/SitemapPHP/Sitemap.php';


   	use SitemapPHP\Sitemap;

	$sitemap = new Sitemap('');

Now, we need to define path for saving XML files. This can be relative like xmls or absolute /path/to/your/folder and must be a writable folder. In default it uses same folder with your script.


Generated XML file names defaulted to sitemap-*.xml, you can customize prefix of filenames with setFilename method.


We'll add sitemap url's with addItem method. In this method, only first parameter (location) is required.

	$sitemap->addItem('/', '1.0', 'daily', 'Today');
	$sitemap->addItem('/about', '0.8', 'monthly', 'Jun 25');
	$sitemap->addItem('/contact', '0.6', 'yearly', '14-12-2009');

w/ method chaining.

	$sitemap->addItem('/projects', '0.8')->addItem('/somepage')->addItem('/hiddenpage', '0.4', 'yearly', '01-01-2011')->addItem('/rss');

from a sql result, or whatever.

	$query = Doctrine_Query::create()
					->select('p.created_at, p.slug')
					->from('Posts p')
					->orderBy(' DESC')
	$posts =  $query->fetchArray(array(), Doctrine_Core::HYDRATE_ARRAY);
    	foreach ($posts as $post) {
        	$sitemap->addItem('/post/' . $post['slug'], '0.6', 'weekly', $post['created_at']);

If you need to change domain for sitemap instance, you can override it via setDomain method.


Finally we create index for sitemap files. This method also closes tags of latest generated xml file.

	$sitemap->createSitemapIndex('', 'Today');

When you run your script, it generates and saves XML files to given path.


<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="">


<?xml version="1.0" encoding="UTF-8"?>
<sitemapindex xmlns="">

You need to submit sitemap-index.xml to Google Sitemaps.


This package is maintained by Evert Pot, David Oti, Osman Ungur, Mike Lay, Userlond, Philipp Scheit, and you!


This package is licensed under the MIT license.

You can’t perform that action at this time.