PHPackages                             envytek/sitemap-generator - 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. [Utility & Helpers](/categories/utility)
4. /
5. envytek/sitemap-generator

ActiveLibrary[Utility & Helpers](/categories/utility)

envytek/sitemap-generator
=========================

Sitemap and sitemap index builder

v1.0.4(5y ago)04.6k[1 issues](https://github.com/envytek/sitemap-generator/issues)BSD-3-ClausePHPPHP >=7.1.0

Since Jan 18Pushed 4y agoCompare

[ Source](https://github.com/envytek/sitemap-generator)[ Packagist](https://packagist.org/packages/envytek/sitemap-generator)[ Docs](https://github.com/envytek/sitemap)[ RSS](/packages/envytek-sitemap-generator/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (2)Dependencies (1)Versions (6)Used By (0)

Sitemap
=======

[](#sitemap)

Multilingual sitemap builder.

[![](https://camo.githubusercontent.com/6259b12bc9a648b14640c8d4620566a85b74317021b29248c92743ed2f7a57de/68747470733a2f2f7472617669732d63692e6f72672f456e767954656b2f736974656d61702e737667)](https://camo.githubusercontent.com/6259b12bc9a648b14640c8d4620566a85b74317021b29248c92743ed2f7a57de/68747470733a2f2f7472617669732d63692e6f72672f456e767954656b2f736974656d61702e737667)

Features
--------

[](#features)

- Create sitemap files: either regular or gzipped.
- Sitemap extensions support. Included extensions are multi-language sitemaps, video/image siteamaps.
- Create sitemap index files.
- Automatically creates new file if either URL limit or file size limit is reached.
- Fast and memory efficient.

Installation
------------

[](#installation)

Installation via Composer is very simple:

```
composer require EnvyTek/
composer require EnvyTek/sitemap:dev-master

```

After that, make sure your application autoloads Composer classes by including `vendor/autoload.php`.

How to use it
-------------

[](#how-to-use-it)

```
use EnvyTek\Sitemap\Sitemap;
use EnvyTek\Sitemap\Index;

// create sitemap
$sitemap = new Sitemap(__DIR__ . '/sitemap.xml');

// add some URLs
$sitemap->addUrl(new Url('http://example.com/mylink1'));
$sitemap->addUrl(
    (new Url('http://example.com/mylink2'))
        ->setLastModified(new \DateTime())
);
$sitemap->addUrl(
    (new Url('http://example.com/mylink3'))
        ->setLastModified(new \DateTime())
        ->setChangeFrequency(Frequency::HOURLY)
);
$sitemap->addUrl(
    (new Url('http://example.com/mylink4'))
        ->setChangeFrequency(Frequency::DAILY)
        ->setLastModified(new \DateTime())
        ->setPriority(0.3)
);

// write it
$sitemap->write();

// get URLs of sitemaps written
$sitemapFileUrls = $sitemap->getSitemapUrls('http://example.com/');

// create sitemap for static files
$staticSitemap = new Sitemap(__DIR__ . '/sitemap_static.xml');

// add some URLs
$staticSitemap->addUrl(new Url('http://example.com/about'));
$staticSitemap->addUrl(new Url('http://example.com/tos'));
$staticSitemap->addUrl(new Url('http://example.com/jobs'));

// write it
$staticSitemap->write();

// get URLs of sitemaps written
$staticSitemapUrls = $staticSitemap->getSitemapUrls('http://example.com/');

// create sitemap index file
$index = new Index(__DIR__ . '/sitemap_index.xml');

// add URLs
foreach ($sitemapFileUrls as $sitemapUrl) {
    $index->addSitemap($sitemapUrl);
}

// add more URLs
foreach ($staticSitemapUrls as $sitemapUrl) {
    $index->addSitemap($sitemapUrl);
}

// write it
$index->write();
```

Multi-language sitemap
----------------------

[](#multi-language-sitemap)

```
use EnvyTek\Sitemap\Sitemap;

// create sitemap declaring you need alternate links support
$sitemap = new Sitemap(__DIR__ . '/sitemap_multi_language.xml', [AlternateLink::class]);

// add some URLs

$sitemap->addUrl(
    (new Url('http://example.com/en/mylink2'))
        ->setLastModified(new \DateTime())
        ->setChangeFrequency(Frequency::HOURLY)
        ->add(new AlternateLink('en', 'http://example.com/en/mylink1'))
        ->add(new AlternateLink('ru', 'http://example.com/ru/mylink1'))
);

$sitemap->addUrl(
    (new Url('http://example.com/en/mylink2'))
        ->setLastModified(new \DateTime())
        ->setChangeFrequency(Frequency::HOURLY)
        ->add(new AlternateLink('en', 'http://example.com/en/mylink2'))
        ->add(new AlternateLink('ru', 'http://example.com/ru/mylink2'))
);

// write it
$sitemap->write();
```

Options
-------

[](#options)

There are methods to configure `Sitemap` instance:

- `setMaxUrls($number)`. Sets maximum number of URLs to write in a single file. Default is 50000 which is the limit according to specification and most of existing implementations.
- `setMaxBytes($number)`. Sets maximum size of a single site map file. Default is 10MiB which should be compatible with most current search engines.
- `setBufferSize($number)`. Sets number of URLs to be kept in memory before writing it to file. Default is 10. Bigger values give marginal benefits. On the other hand when the file size limit is hit, the complete buffer must be written to the next file.
- `setUseIndent($bool)`. Sets if XML should be indented. Default is true.
- `setUseGzip($bool)`. Sets whether the resulting sitemap files will be gzipped or not. Default is `false`. `zlib` extension must be enabled to use this feature.

There is a method to configure `Index` instance:

- `setUseGzip($bool)`. Sets whether the resulting index file will be gzipped or not. Default is `false`. `zlib` extension must be enabled to use this feature.

Running tests
-------------

[](#running-tests)

In order to run tests perform the following commands:

```
composer install
./vendor/bin/phpunit

```

###  Health Score

28

—

LowBetter than 54% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity20

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity52

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% 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 ~0 days

Total

4

Last Release

1946d ago

Major Versions

v0.1.0 → v1.0.22021-01-19

### Community

Maintainers

![](https://www.gravatar.com/avatar/18323ea8c8e78acb37d5cb0bb8f9cb6e5886bd63a7ba4a5ca6385e5b7fbf6020?d=identicon)[envytek](/maintainers/envytek)

---

Top Contributors

[![ares235](https://avatars.githubusercontent.com/u/45092784?v=4)](https://github.com/ares235 "ares235 (9 commits)")

---

Tags

Sitemap

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/envytek-sitemap-generator/health.svg)

```
[![Health](https://phpackages.com/badges/envytek-sitemap-generator/health.svg)](https://phpackages.com/packages/envytek-sitemap-generator)
```

###  Alternatives

[samdark/sitemap

Sitemap and sitemap index builder

5491.4M37](/packages/samdark-sitemap)[novactive/ezseobundle

Novactive eZ SEO Bundle is an Ibexa Platform bundle for SEO simplications. metas, sitemaps, robots.txt, etc.

26252.0k2](/packages/novactive-ezseobundle)[zhelyabuzhsky/yii2-sitemap

A Yii2 tool to generate sitemap.xml.

3439.7k](/packages/zhelyabuzhsky-yii2-sitemap)[fof/sitemap

Generate a sitemap

1988.7k2](/packages/fof-sitemap)[kphoen/sitemap-bundle

Provides a way to create/generate a sitemap using Doctrine, etc.

2444.8k](/packages/kphoen-sitemap-bundle)[fomvasss/laravel-meta-tags

A package to manage SEO (meta-tags, xml-fields, etc.)

3028.9k](/packages/fomvasss-laravel-meta-tags)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)