PHPackages zhelyabuzhsky/yii2-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. [Utility & Helpers](/categories/utility) 4. / 5. zhelyabuzhsky/yii2-sitemap ActiveYii2-extension[Utility & Helpers](/categories/utility) zhelyabuzhsky/yii2-sitemap ========================== A Yii2 tool to generate sitemap.xml. 1.2.0(7y ago)3439.7k↓41.7%11GPL-3.0PHP Since Jun 20Pushed 7y ago5 watchersCompare [ Source](https://github.com/zhelyabuzhsky/yii2-sitemap)[ Packagist](https://packagist.org/packages/zhelyabuzhsky/yii2-sitemap)[ Docs](https://github.com/zhelyabuzhsky/yii2-sitemap)[ RSS](/packages/zhelyabuzhsky-yii2-sitemap/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (7)Dependencies (2)Versions (10)Used By (0) Sitemap.xml generator for Yii2 ============================== [](#sitemapxml-generator-for-yii2) [![Build Status](https://camo.githubusercontent.com/4d1d8acda3d6b3a77c13dcb0b4652314db1a4ce30c03b650966485234d35d27d/68747470733a2f2f7472617669732d63692e6f72672f7a68656c796162757a68736b792f796969322d736974656d61702e737667)](https://travis-ci.org/zhelyabuzhsky/yii2-sitemap)[![Total Downloads](https://camo.githubusercontent.com/73bb0439d72220219286671dc015234540c453e5f47889f9ac9590ad2ff8b07a/68747470733a2f2f706f7365722e707567782e6f72672f7a68656c796162757a68736b792f796969322d736974656d61702f646f776e6c6f616473)](https://packagist.org/packages/zhelyabuzhsky/yii2-sitemap) Yii2 extension to generate sitemap files for large web-sites through Yii2 [console command](https://www.yiiframework.com/doc/guide/2.0/en/tutorial-console) Installation ------------ [](#installation) The preferred way to install this extension is through [composer](http://getcomposer.org/download/). ``` $ php composer.phar require zhelyabuzhsky/yii2-sitemap ``` or add ``` "zhelyabuzhsky/yii2-sitemap": "^1.1" ``` to the require section of your `composer.json` file. Features -------- [](#features) - Generates multiple sitemaps (large sites) - Creates index sitemap file - Gzip compression of .xml files - Disallow urls support (through regular expression array) Configuration ------------- [](#configuration) ### 1. Configure `urlManager` at console config [](#1-configure-urlmanager-at-console-config) ``` 'urlManager' => [ 'hostInfo' => 'https://example.com', 'baseUrl' => '/', 'rules' => [ // ... ], ], ``` **NOTE** Both params `hostInfo` and `baseUrl` are required for Yii2 console app. **NOTE** `urlManager` `rules` section usually repeats your frontend `urlManager` configuration, so you could merge it at console config (see [yiisoft/yii2#1578 (comment)](https://github.com/yiisoft/yii2/issues/1578#issuecomment-66716648)): Show details`console/main.php` ``` $frontendUrlManager = require(__DIR__ . '/../../frontend/config/UrlManager.php'); //... 'urlManager' => array_merge($frontendUrlManager, [ 'hostInfo' => 'https://example.com' ]), ``` `frontend/config/UrlManager.php` ``` ``` ### 2. Configure `Sitemap` component at console config components section [](#2-configure-sitemap-component-at-console-config-components-section) ``` 'components' => [ 'sitemap' => [ 'class' => '\zhelyabuzhsky\sitemap\components\Sitemap', ], ], ``` Example of using extra `Sitemap` params ``` 'components' => [ 'sitemap' => [ 'class' => '\zhelyabuzhsky\sitemap\components\Sitemap', 'maxUrlsCountInFile' => 10000, 'sitemapDirectory' => 'frontend/web', 'optionalAttributes' => ['changefreq', 'lastmod', 'priority'], 'maxFileSize' => '10M', ], ], ``` where - `maxUrlsCountInFile` - max count of urls in one sitemap file; - `sitemapDirectory` - directory to place sitemap files; - `optionalAttributes` - list of used optional attributes; - `maxFileSize` - maximal file size. Zero to work without limits. So you can specify the following abbreviations k - kilobytes and m - megabytes. By default 10m. Usage ----- [](#usage) ### 1. Impement `SitemapEntityInterface` for the models you want to use at sitemap [](#1-impement-sitemapentityinterface-for-the-models-you-want-to-use-at-sitemap) Show example`common\models\Category.php` ``` use yii\db\ActiveRecord; use zhelyabuzhsky\sitemap\models\SitemapEntityInterface; class Category extends ActiveRecord implements SitemapEntityInterface { /** * @inheritdoc */ public function getSitemapLastmod() { return date('c'); } /** * @inheritdoc */ public function getSitemapChangefreq() { return 'daily'; } /** * @inheritdoc */ public function getSitemapPriority() { return 0.5; } /** * @inheritdoc */ public function getSitemapLoc() { // Use urlManager rules to create urls return $url = Yii::$app->urlManager->createAbsoluteUrl([ 'page/view', 'pageSlug' => $this->slug, ]); // or directly // return 'http://localhost/' . $this->slug; } /** * @inheritdoc */ public static function getSitemapDataSource() { return self::find(); } } ``` ### 2. Create Yii2 [controller for console command](https://www.yiiframework.com/doc/guide/2.0/en/tutorial-console#create-command) [](#2-create-yii2-controller-for-console-command) ``` use yii\console\Controller; class SitemapController extends Controller { public function actionCreate() { \Yii::$app->sitemap ->addModel(Item::className()) ->addModel(Category::className(), \Yii::$app->db) // Also you can pass \yii\db\Connection to the database connection that you need to use ->setDisallowUrls([ '#url1#', '#url2$#', ]) ->create(); } } ``` ### 3. Run console command [](#3-run-console-command) ``` php yii sitemap/create ``` Testing ------- [](#testing) Set enviroment variable SERVER\_NAME (e.g. ) ``` $ ./vendor/bin/phpunit ``` Security -------- [](#security) If you discover any security related issues, please email instead of using the issue tracker. Credits ------- [](#credits) - [Ilya Zhelyabuzhsky](https://github.com/zhelyabuzhsky) - [All Contributors](../../contributors) License ------- [](#license) GNU General Public License, version 3. Please see [License File](LICENSE) for more information. ### Health Score 41 — FairBetter than 89% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity40 Moderate usage in the ecosystem Community19 Small or concentrated contributor base Maturity69 Established project with proven stability Bus Factor1 Top contributor holds 51.6% 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 ~223 days Recently: every ~273 days Total 7 Last Release 2644d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/4eb3f3e0e4d4c7f830cec733ec488a016894b927ac070f4d940de63c1d8d26ca?d=identicon)[zhelyabuzhsky](/maintainers/zhelyabuzhsky) --- Top Contributors [![zhelyabuzhsky](https://avatars.githubusercontent.com/u/687543?v=4)](https://github.com/zhelyabuzhsky "zhelyabuzhsky (33 commits)")[![pastuhov](https://avatars.githubusercontent.com/u/7937221?v=4)](https://github.com/pastuhov "pastuhov (18 commits)")[![fakegod](https://avatars.githubusercontent.com/u/16721215?v=4)](https://github.com/fakegod "fakegod (5 commits)")[![PaVeL-Ekt](https://avatars.githubusercontent.com/u/2797861?v=4)](https://github.com/PaVeL-Ekt "PaVeL-Ekt (4 commits)")[![nick-denry](https://avatars.githubusercontent.com/u/1450983?v=4)](https://github.com/nick-denry "nick-denry (2 commits)")[![pahanini](https://avatars.githubusercontent.com/u/898663?v=4)](https://github.com/pahanini "pahanini (2 commits)") --- Tags sitemapyii2-extensionyii2-sitemapyii2Sitemap ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/zhelyabuzhsky-yii2-sitemap/health.svg) ``` [![Health](https://phpackages.com/badges/zhelyabuzhsky-yii2-sitemap/health.svg)](https://phpackages.com/packages/zhelyabuzhsky-yii2-sitemap) ``` ### Alternatives [mrssoft/yii2-sitemap Yii2 sitemap extension 1123.9k1](/packages/mrssoft-yii2-sitemap)[dmstr/yii2-cookie-consent Yii2 Cookie Consent Widget 1452.6k](/packages/dmstr-yii2-cookie-consent) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)