Подключение Sitemap.xml

Для формирования sitemap.xml на сайте рекомендованно использовать расширение: “himiklab/yii2-sitemap-module“: версии ~1.2.0.

Для настройки следует выполнить следующие шаги:

1. Подключить модуль в конфигурационном файле приложения frontend/config/main.php.

    'modules' => [
        'sitemap' => [
            'class' => 'himiklab\sitemap\Sitemap',
            'cacheExpire' => 1,
        ],
    ]

   А также настроить роутинг добавив пункт в секцию urlManager.rules.

    ['pattern' => 'sitemap', 'route' => 'sitemap/default/index', 'suffix' => '.xml'],

2. Далее необходимо в каждом модуле, вывод данных которого необходимо настроить в sitemap.xml, добавить в конфигурацию подключение AR моделей.

    'modules' => [
        'sitemap' => [
            'models' => [
                'common\modules\content\models\Post',
            ],
        ],
    ]

   На примере модуля “Контент”.

3. Помимо этого в подключенные модели из предыдущего шага необходимо добавить поведение.

    'sitemap' => [
        'class' => SitemapBehavior::class,
        'scope' => function ($model) {
            /** @var PostQuery $model */
            $model->select(['url', 'type_id', 'updated_at']);
            $model->isPublished()->isActive();
        },
        'dataClosure' => function ($model) {
            /** @var self $model */
            return [
                'loc' => $model->getFullUrl(),
                'lastmod' => $model->updated_at,
                'changefreq' => SitemapBehavior::CHANGEFREQ_DAILY,
                'priority' => $model->sitemap ?: self::DEFAULT_SITEMAP
            ];
        }
    ],

   Не стоит забывать о том, что поле priority стоит хранить в базе данных, если необходима ручная настройка для каждой отдельно записи.

   1. Пример миграции добавления поля для хранения priority:

      /**
      * {@inheritdoc}
      */
      public function safeUp()
      {
       $this->addColumn('{{%content_post}}', 'sitemap', $this->decimal(2, 1)->notNull()->defaultValue(0.8)->after('active')->comment('Приоритет Sitemap'));
      }
      /**
      * {@inheritdoc}
      */
      public function safeDown()
      {
       $this->dropColumn('{{%content_post}}', 'sitemap');
      }

   2. Также необходимо добавить поле для редактирования этого значения в форме редактирования модели: <?= $form->field($model, 'priority')->textInput(); ?>.
4. Кроме данных моделей в sitemap.xml также можно добавлять ссылки на статические страницы (например, страница “Контакты”, “О компании”), что достаточно подробно описано в документации самого расширения https://github.com/himiklab/yii2-sitemap-module
   См. ключ конфигурации modules.sitemap.urls.

    'urls'=> [
        // your additional urls
        [
            'loc' => '/news/index',
            'changefreq' => \himiklab\sitemap\behaviors\SitemapBehavior::CHANGEFREQ_DAILY,
            'priority' => 0.8,
            'news' => [
                'publication'   => [
                    'name'          => 'Example Blog',
                    'language'      => 'en',
                ],
                'access'            => 'Subscription',
                'genres'            => 'Blog, UserGenerated',
                'publication_date'  => 'YYYY-MM-DDThh:mm:ssTZD',
                'title'             => 'Example Title',
                'keywords'          => 'example, keywords, comma-separated',
                'stock_tickers'     => 'NASDAQ:A, NASDAQ:B',
            ],
            'images' => [
                [
                    'loc'           => 'http://example.com/image.jpg',
                    'caption'       => 'This is an example of a caption of an image',
                    'geo_location'  => 'City, State',
                    'title'         => 'Example image',
                    'license'       => 'http://example.com/license',
                ],
            ],
        ],
    ],

   Статичные ссылки можно добавлять как через конфигурацию приложения, если они глобальные и относятся к приложению, либо через конфигурацию отдельно взятого модуля, если ссылки локальны внутри модуля, но должны быть доступны в sitemap.xml.