Customize the sitemap path

(fix typo)

Here is a patch with tests! Reviews welcome!

Added some coding standards fixes.

I think I will need to add the paths <nolink>, <button>, and <current> to the list of disallowed paths (these are defined in web/core/modules/system/system.routing.yml with <front> and <none>, which are already disallowed).

Here's an updated patch; reviews welcome. Here's a deeper dive into why I wrote the patch this way...

The special routes/paths we handle as special cases in the validation function are defined in web/core/modules/system/system.routing.yml as follows...

'<front>':
  path: '/'
  defaults:
    _title: Home
  requirements:
    _access: 'TRUE'

'<none>':
  path: ''
  options:
    _no_path: TRUE
  requirements:
    _access: 'TRUE'

'<nolink>':
  path: ''
  options:
    _no_path: TRUE
  requirements:
    _access: 'TRUE'

'<button>':
  path: ''
  options:
    _no_path: TRUE
  requirements:
    _access: 'TRUE'

'<current>':
  path: '<current>'

Note that <front> and <current> both have an explicitly-set path (and note that both the route name and path for <current> is the same string); but the other special routes do not.

Our validation code is looking at paths, not route names. We want to avoid unexpected behavior, so we disallow the paths / and <current>.

Setting the sitemap path to one of the reserved route names that are not also paths (<front>, <none>, <nolink> and <button>) should work just fine, but it would be confusing to people accustomed to see them interpreted as route names elsewhere in the Drupal UI (and of limited use in the real world), so we disallow those as well.

... Hopefully that makes sense!

#6 works for me

Awesome, thanks @firewaller!

I've created a merge request and fixed some lints. If everything works, I will merge tomorrow.

Merged!

Automatically closed - issue fixed for 2 weeks with no activity.

Note that this change was released in sitemap-8.x-2.0-beta7 → ; but resulted in a follow-up issue, 🐛 Route "sitemap.page" does not exist error after upgrading to 8.x-2.0-beta7 Fixed which was released in sitemap-8.x-2.0-beta9 →