Install

Works with Drupal: 8.x

Using Composer to manage Drupal site dependencies

Alternative installation files

Download tar.gz 94.75 KB
MD5: 166268627fae59ade4742ddb98aa518c
SHA-1: 0bfa5124574c49fb481efc0b0c1fdd979ed3e7f8
SHA-256: 7ae6afd8b9676aafd80749b8cb084dc011fd7212b875f579ac1c5330eadcce18
Download zip 153.84 KB
MD5: 47ced86285818e4114492b94f713a98d
SHA-1: 7cb1944ca2659e426e20680ef8e7cd48747545c8
SHA-256: 223e09df5ea1438f0041c80005564196a8074e76d99f1ee50746caf2907860a0

Release notes

Changes since 3.3

New features

#3045811: Submit generated XML sitemap to search engines automatically

Bug fixes

#3079897: entity_legal add form breaks with simple_sitemap
#3078369: Error: Call to a member function getFileUri()
#3080510: Assertion error on multi-step form node creation
#3078910: Error: Call to a member function set() on null

Improvements

#3070304: Tuning the worker script
#3084261: \Drupal\simple_sitemap\EntityHelper has unused dependency on Connection

Changes since 2.x

Ability to create any type of sitemap via plugins

The 8.x-3.x release allows not only for customizing the URL generation through UrlGenerator plugins as 2.x does, but also creating multiple custom sitemap types through sitemapGenerator plugins and running all the sitemaps on the same Drupal instance. Now e.g a Google news sitemap can be added to a Drupal instance. This is possible through the new concept of sitemap variants.

Ability to create sitemap variants of various sitemap types via UI

Now e.g links form a specific entity bundle can be indexed in a specific sitemap variant with its own URL.

No more out of memory/time errors

The generation process has been streamlined to using a single queue regardless of whether batch generation is being used, or backend (cron/drush) processes. This should allow hundreds of thousands of entities/elements being indexed without memory errors.
If there is a problem, the generation process picks up from the last indexed element. The sitemap variants are only published after the generation has been completed.

Other

  • Automatic submission to search engines
  • Views and views arguments support
  • XSL stylesheets for human visitors

Upgrade path from 2.x

There is an upgrade path from 8.x-2.x for regular users, however the API of the module has undergone several changes and custom code may need adjustments.

API changes since 3.3

None. Please make sure to use the below simple_sitemap.generator service API instead of accessing the module's configuration storage directly.

API methods

  • getSetting
  • saveSetting
  • setVariants
  • getSitemap
  • removeSitemap
  • generateSitemap
  • rebuildQueue
  • enableEntityType
  • disableEntityType
  • setBundleSettings
  • getBundleSettings
  • removeBundleSettings
  • setEntityInstanceSettings
  • getEntityInstanceSettings
  • removeEntityInstanceSettings
  • bundleIsIndexed
  • entityTypeIsEnabled
  • addCustomLink
  • getCustomLinks
  • removeCustomLinks
  • getSitemapManager
    • getSitemapVariants
    • addSitemapVariant
    • removeSitemapVariants
  • getQueueWorker
    • deleteQueue
    • rebuildQueue
    • getInitialElementCount
    • getQueuedElementCount
    • getStashedResultCount
    • getProcessedElementCount
    • generationInProgress

Hooks

  • hook_simple_sitemap_links_alter(&$links, $sitemap_variant)
  • hook_simple_sitemap_arbitrary_links_alter(&$arbitrary_links, $sitemap_variant)
  • hook_simple_sitemap_attributes_alter(&$attributes, $sitemap_variant)
  • hook_simple_sitemap_index_attributes_alter(&$index_attributes, $sitemap_variant)
  • hook_simple_sitemap_url_generators_alter(&$url_generators)
  • hook_simple_sitemap_sitemap_generators_alter(&$sitemap_generators)
  • hook_simple_sitemap_sitemap_types_alter(&$sitemap_types)

Check out this resource for more details about the module and in-depth tutorials.

Created by: gbyte
Created on: 7 Oct 2019 at 10:57 UTC
Last updated: 15 Dec 2019 at 17:03 UTC
Bug fixes
New features
Unsupported

Other releases