Drupal 12 compatibility [#3603045]

Problem/Motivation

Hello project maintainers,

This is an automated issue to help make this module compatible with Drupal 12.

Changes will periodically be added to this issue that remove deprecated API uses. To stop further changes from being posted, change the status to anything other than Active, Needs review, Needs work or Reviewed and tested by the community. Alternatively, you can remove the "ProjectUpdateBotD12" tag from the issue to stop the bot from posting updates.

The changes will be posted by the Project Update Bot official user account. This account will not receive any issue credit contributions for itself or any company.

Proposed resolution

You have a few options for how to use this issue:

Accept automated changes until this issue is closed
If this issue is left open (status of Active, Needs review, Needs work or Reviewed and tested by the community) and the "ProjectUpdateBotD12" tag is left on this issue, new changes will be posted periodically if new deprecation fixes are needed.

As the Drupal Rector project improves and is able to fix more deprecated API uses, the changes posted here will cover more of the deprecated API uses in the module.

Patches and/or merge requests posted by others are ignored by the bot, and general human interactions in the issue do not stop the bot from posting updates, so feel free to use this issue to refine bot changes. The bot will still post new changes then if there is a change in the new generated patch compared to the changes that the bot posted last. Those changes are then up to humans to integrate.
Leave open but stop new automated changes.
If you want to use this issue as a starting point to remove deprecated API uses but then don't want new automated changes, remove the "ProjectUpdateBotD12" tag from the issue and use it like any other issue (the status does not matter then). If you want to receive automated changes again, add back the "ProjectUpdateBotD12" tag.
Close it and don't use it
If the maintainers of this project don't find this issue useful, they can close this issue (any status besides Active, Needs review, Needs work and Reviewed and tested by the community) and no more automated changes will be posted here.

If the issue is reopened, then new automated changes will be posted.

If you are using another issue(s) to work on Drupal 12 compatibility it would be very useful to other contributors to add those issues as "Related issues" when closing this issue.

Remaining tasks

Using the patches

Apply the latest patch in the comments by Project Update Bot or human contributors that made it better.
Thoroughly test the patch. These patches are automatically generated so they haven't been tested manually or automatically.
Provide feedback about how the testing went. If you can improve the patch, post an updated patch here.

Using the merge request

Review the merge request and test it.
Thoroughly test the changes. These changes are automatically generated so they haven't been tested manually or automatically.
Provide feedback about how the testing went. If you can improve the merge request, create a new branch and merge request and work from there.

Warning: The 'project-update-bot-only' branch will always be overwritten. Do not work in that branch!

Providing feedback

If there are problems with one of the changes posted by the Project Update Bot, such as it does not correctly replace a deprecation, you can file an issue in the Drupal Rector issue queue. For other issues with the bot, for instance if the issue summary created by the bot is unclear, use the Project analysis issue queue.

Comment	File	Size	Author
#9	simple_sitemap.4.x-dev.upgrade_status.post_rector.txt	13.3 KB	project update bot
#9	simple_sitemap.4.x-dev.rector.patch	41.74 KB	project update bot
#9	interdiff-last-bot.7165820.txt	2.06 KB	project update bot
#5	simple_sitemap.4.x-dev.upgrade_status.post_rector.txt	3.84 KB	project update bot
#5	simple_sitemap.4.x-dev.rector.patch	39.82 KB	project update bot
#5	interdiff-last-bot.7151864.txt	8.58 KB	project update bot
#4	simple_sitemap.4.x-dev.upgrade_status.post_rector.txt	3.84 KB	project update bot
#4	simple_sitemap.4.x-dev.rector.patch	40.27 KB	project update bot
#4	interdiff-last-bot.7141060.txt	2.55 KB	project update bot
#2	simple_sitemap.4.x-dev.upgrade_status.post_rector.txt	3.84 KB	project update bot
#2	simple_sitemap.4.x-dev.rector.patch	36.93 KB	project update bot

Issue fork simple_sitemap-3603045

Show commands

Start within a Git clone of the project using the version control instructions.

Add & fetch this issue fork’s repository

Or, if you do not have SSH keys set up on git.drupalcode.org:

Add & fetch this issue fork’s repository

drupal12 changes, plain diff MR !152
Check out this branch for the first time

Check out existing branch, if you already have it locally
project-update-bot-only changes, plain diff MR !147
Check out this branch for the first time

Check out existing branch, if you already have it locally
3603045-automated-drupal-12 compare
Check out this branch for the first time

Check out existing branch, if you already have it locally

About issue forks

Comments

Comment #1

17 June 2026 at 15:23

project update bot created an issue. See original summary.

Comment #2

project update bot commented 17 June 2026 at 15:23

Status:

Active

» Needs review

Status	File	Size
new	simple_sitemap.4.x-dev.rector.patch	36.93 KB
new	simple_sitemap.4.x-dev.upgrade_status.post_rector.txt	3.84 KB

This is an automated patch generated using Upgrade Status and Drupal Rector. Please see the issue summary for more details. A merge request (MR) is also openend and updated.

It is important that any automated tests available are run and that you manually test the changes.

Drupal 12 Compatibility

According to the Upgrade Status module, even with these changes, this module is not yet compatible with Drupal 12.

Currently Drupal Rector, version 1.0.0-beta1, cannot fix all Drupal 12 compatibility problems.

Therefore, these changes did not update the info.yml file for Drupal 12 compatibility.

The compatibility issues that Upgrade Status found after the Drupal Rector fixes were applied are attached to help you resolve them manually.

Leaving this issue open, even after committing the current patch or merging the MR, will allow the Project Update Bot to post additional Drupal 12 compatibility fixes as they become available in Drupal Rector.

Debug information

Bot run #12-848511

These packages were used to generate the fixes:

drupal/upgrade_status: 5.0.0-alpha2
mglaman/phpstan-drupal: 2.0.15
palantirnet/drupal-rector: 1.0.0-beta1

Comment #3

17 June 2026 at 15:23

project update bot opened merge request !147

Comment #4

project update bot commented 1 July 2026 at 06:11

Status	File	Size
new	interdiff-last-bot.7141060.txt	2.55 KB
new	simple_sitemap.4.x-dev.rector.patch	40.27 KB
new	simple_sitemap.4.x-dev.upgrade_status.post_rector.txt	3.84 KB

This is an automated patch generated using Upgrade Status and Drupal Rector. Please see the issue summary for more details. A merge request (MR) is also openend and updated.

It is important that any automated tests available are run and that you manually test the changes.

Drupal 12 Compatibility

According to the Upgrade Status module, even with these changes, this module is not yet compatible with Drupal 12.

Currently Drupal Rector, version 1.0.0-beta7, cannot fix all Drupal 12 compatibility problems.

Therefore, these changes did not update the info.yml file for Drupal 12 compatibility.

The compatibility issues that Upgrade Status found after the Drupal Rector fixes were applied are attached to help you resolve them manually.

Debug information

Bot run #12-864040

These packages were used to generate the fixes:

drupal/upgrade_status: 5.0.0-alpha2
mglaman/phpstan-drupal: 2.0.15
palantirnet/drupal-rector: 1.0.0-beta7

Comment #5

project update bot commented 12 July 2026 at 10:51

Status	File	Size
new	interdiff-last-bot.7151864.txt	8.58 KB
new	simple_sitemap.4.x-dev.rector.patch	39.82 KB
new	simple_sitemap.4.x-dev.upgrade_status.post_rector.txt	3.84 KB

This is an automated patch generated using Upgrade Status and Drupal Rector. Please see the issue summary for more details. A merge request (MR) is also openend and updated.

It is important that any automated tests available are run and that you manually test the changes.

Drupal 12 Compatibility

According to the Upgrade Status module, even with these changes, this module is not yet compatible with Drupal 12.

Currently Drupal Rector, version 1.1.1, cannot fix all Drupal 12 compatibility problems.

Therefore, these changes did not update the info.yml file for Drupal 12 compatibility.

The compatibility issues that Upgrade Status found after the Drupal Rector fixes were applied are attached to help you resolve them manually.

Debug information

Bot run #12-884047

These packages were used to generate the fixes:

drupal/upgrade_status: 5.0.0-alpha3
mglaman/phpstan-drupal: 2.0.15
palantirnet/drupal-rector: 1.1.1

Comment #6

4 September 2026 at 03:04

ptmkenny made their first commit to this issue’s fork.

Comment #7

5 September 2026 at 02:00

ptmkenny opened merge request !152

Comment #8

ptmkenny commented 5 September 2026 at 03:10

Issue summary:

View changes

I've added a new branch, drupal12, that does the following:

Applies the Update Bot MR (147)
Requires ^11.4 ||| ^12 (this allows us to avoid a lot of deprecation handling and will be the minimum supported Drupal from December 2026)
Completely migrates to OOP hooks (no more .module files)
Cleans up the phpstan and phpcs issues with the Update Bot MR
Removes deprecated code

Tests are failing on Drupal 12 because composer dependency paragraphs does not yet have a D12 version.

Comment #9

project update bot commented 4 October 2026 at 03:51

Issue summary:

View changes

Status	File	Size
new	interdiff-last-bot.7165820.txt	2.06 KB
new	simple_sitemap.4.x-dev.rector.patch	41.74 KB
new	simple_sitemap.4.x-dev.upgrade_status.post_rector.txt	13.3 KB

This is an automated patch generated using Upgrade Status and Drupal Rector. Please see the issue summary for more details. A merge request (MR) is also openend and updated.

It is important that any automated tests available are run and that you manually test the changes.

Drupal 12 Compatibility

According to the Upgrade Status module, even with these changes, this module is not yet compatible with Drupal 12.

Currently Drupal Rector, version 1.1.3, cannot fix all Drupal 12 compatibility problems.

Therefore, these changes did not update the info.yml file for Drupal 12 compatibility.

The compatibility issues that Upgrade Status found after the Drupal Rector fixes were applied are attached to help you resolve them manually.

Debug information

Bot run #12-978641

These packages were used to generate the fixes:

drupal/upgrade_status: 5.0.0-alpha3
mglaman/phpstan-drupal: 2.2.1
palantirnet/drupal-rector: 1.1.3

Comment #10

orkutmuratyilmaz

Turkish

İzmir

commented 14 October 2026 at 11:12

Issue summary:	View changes
Status:	Needs review	» Needs work

Comment #11

ptmkenny commented 14 October 2026 at 15:11

@orkutmuratyilmaz Could you please explain why you set this to "Needs work"? I have an open MR with drupal 12 support: https://git.drupalcode.org/project/simple_sitemap/-/merge_requests/152

Comment #12

orkutmuratyilmaz

Turkish

İzmir

commented 15 October 2026 at 07:39

Status:

Needs work

» Needs review

@ptmkenny, sorry, my bad. I've only checked MR !147. now I'm checking MR !152 and changing the status as Needs review again.

Comment #13

orkutmuratyilmaz

Turkish

İzmir

commented 15 October 2026 at 07:45

Here are my review notes on MR !152:

SimpleSitemapHooks::help() still reads file_get_contents(__DIR__ . '/README.md'). Since the code moved to src/Hook/, __DIR__ no longer points to the module root, so the help page can't find the README (a warning and empty output). Something like dirname(__DIR__, 2) . '/README.md' should fix it.
With core_version_requirement: ^11.4 || ^12, the OPT_IN_TEST_PREVIOUS_MAJOR and OPT_IN_TEST_PREVIOUS_MINOR jobs in .gitlab-ci.yml can no longer install the module, so I think they should be removed.
SimpleSitemapViewsHooks has a leftover @file docblock inside the class body, which can be removed.
Not a blocker, just a suggestion: SimpleSitemapHooks injects the generator, queue worker, entity manager, form helper etc. in its constructor. Since page_attachments_alter and form_alter run on almost every request, that whole service graph is now built each time. Moving the frequently fired hooks to a lighter class, or using lazy services or service closures, could avoid that.

Keeping the status at Needs review, since these are small fixes.

Comment #14

ptmkenny commented 15 October 2026 at 08:52

@orkutmuratyilmaz Thanks for the review.

1. Good catch! Fixed. By the way, how did you find this? I imagine I've missed this error before too when converting other modules, so any tips about how to detect it would be appreciated.

2. I disagree. When Drupal 12 is released, PREVIOUS_MAJOR will be 11.5, so we will want that enabled again. If we disable it now, we will have to enable it again in December.

3. Fixed.

4. I split up the hooks roughly by function. I am not sure if this is an improvement or not, but I did it in a single commit so it can easily be reverted if the maintainer would prefer to keep all the hooks together.

Comment #15

orkutmuratyilmaz

Turkish

İzmir

commented 15 October 2026 at 08:59

Status:

Needs review

» Reviewed & tested by the community

@ptmkenny, I've checked your MR with Cyber Tiel Coder and it found that one. Sorry for not mentioning it before.

Since your latest commits are done, I'm changing the issue's status as RTBC now.

Comment #16

gbyte

Berlin

commented 19 October 2026 at 06:30

Parent issue:

» #3631636: Prepare a 5.x stable release

Comment #17

19 October 2026 at 06:55

gbyte committed 2040f60a on 5.x

task: #3603045 Drupal 12 compatibility

By: ptmkenny
By:...

Comment #18

gbyte

Berlin

commented 19 October 2026 at 06:59

Status:

Reviewed & tested by the community

» Active

Thanks.

4. I split up the hooks roughly by function. I am not sure if this is an improvement or not, but I did it in a single commit so it can easily be reverted if the maintainer would prefer to keep all the hooks together.

I commited it this way for now. Would it help to instead drop dependency injection in the hook class and just use the services procedurally inside the hooks? What do you guys think?

Comment #19

ptmkenny commented 19 October 2026 at 08:41

@gbyte I think it's better to use DI in the hooks for consistency with core. I don't think there is a big performance impact anyway unless you're using a rare and heavy service; Drupal core already loads and caches a lot of services every bootstrap anyway.