Automated Drupal 10 compatibility fixes

Created on 15 June 2022, about 2 years ago
Updated 7 November 2023, 8 months ago

Problem/Motivation

Hello project maintainers,

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

To read more about this effort by the Drupal Association, please read: The project update bot is being refreshed to support Drupal 10 readiness of contributed projects β†’

Patches will periodically be added to this issue that remove Drupal 10 deprecated API uses. To stop further patches 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 "ProjectUpdateBotD10" tag from the issue to stop the bot from posting updates.

The patches 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:

  1. Accept automated patches 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 "ProjectUpdateBotD10" tag is left on this issue, new patches 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 patches 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 patches. The bot will still post new patches then if there is a change in the new generated patch compared to the patch that the bot posted last. Those changes are then up to humans to integrate.

  2. Leave open but stop new automated patches.

    If you want to use this issue as a starting point to remove deprecated API uses but then don't want new automated patches, remove the "ProjectUpdateBotD10" tag from the issue and use it like any other issue (the status does not matter then). If you want to receive automated patches again, add back the "ProjectUpdateBotD10" tag.

  3. 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 patches will be posted here.

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

    If you are using another issue(s) to work on Drupal 10 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

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

Providing feedback

If there are problems with one of the patches 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 β†’ .

πŸ“Œ Task
Status

RTBC

Component

Code

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

  • First commit to issue fork.
  • πŸ‡¨πŸ‡¦Canada teknocat

    It would be really great if this could be merged and deployed as a new minor release version, as the ONLY thing needed is a change to the .info file.

    I created an issue fork, but I'm not sure if I can do anything with it from there.

  • First commit to issue fork.
  • @stephanie-paulantis opened merge request.
  • πŸ‡ΈπŸ‡ͺSweden AndKar

    It would be great if the PR above could be merged.

  • Status changed to RTBC 9 months ago
  • πŸ‡ΊπŸ‡ΈUnited States richgerdes New Jersey, USA

    +1 for MR1.

  • πŸ‡¬πŸ‡§United Kingdom ikit-claw

    Any chance we could get this in a module release?

  • πŸ‡ΊπŸ‡ΈUnited States bdanin

    It's unfortunate there isn't a release for this. For now in my composer.json I have this under the require key:
    "drupalcode/block_type_templates": "3286293",

    And then under repositories, I have this:

            {
                "type": "package",
                "package": {
                    "name": "drupalcode/block_type_templates",
                    "version": "3286293",
                    "type": "drupal-module",
                    "source": {
                        "url": "https://git.drupalcode.org/issue/block_type_templates-3286293.git",
                        "type": "git",
                        "reference": "3286293-6"
                    }
                }
            }
  • πŸ‡ΊπŸ‡ΈUnited States b0b Bethlehem, PA

    Or you could skip this module completely if you just add this code to your THEMENAME.theme file.

    Then use block--bundle--block-name.html.twig as your template name.

    /**
     * Implements hook_theme_suggestions_HOOK_alter() for form templates.
     * @param array $suggestions
     * @param array $variables
     */
    function YOURTHEMENAME_theme_suggestions_block_alter(array &$suggestions, array $variables) {
      // Block suggestions for custom block bundles.
      if (isset($variables['elements']['content']['#block_content'])) {
        array_splice($suggestions, 1, 0, 'block__bundle__' . $variables['elements']['content']['#block_content']->bundle());
      }
    }
  • πŸ‡ΊπŸ‡ΈUnited States bdanin

    Thanks, this gets close, but not all the way there. For one thing, I noticed that I needed to use block__block_content_ instead of block__bundle__ to keep my existing template suggestions the same between the module and this custom theme hook.

    One issue is that the previous hooks, provided by the module output this:

       * block--block-content-BLOCK_NAME--full.html.twig
       x block--block-content-BLOCK_NAME.html.twig
       * block--block-content.html.twig
       * block--block-content.html.twig
       * block.html.twig
    

    But the custom hook in this example misses the display type template (--full).

    vs.

       * block--block-content.html.twig
       x block--block-content-BLOCK_NAME.html.twig
       * block--block-content.html.twig
       * block.html.twig
    

    I'm not actually using the display mode for any of my templates, so losing this suggestion seems ok for my uses, but wanted to point this out in case it affects other's use cases.

    Here is what I'm using currently:

    /**
     * Implements hook_theme_suggestions_HOOK_alter() for form templates.
     * @param array $suggestions
     * @param array $variables
     */
    function YOURTHEMENAME_theme_suggestions_block_alter(array &$suggestions, array $variables) {
      // Block suggestions for custom block bundles.
      if (isset($variables['elements']['content']['#block_content'])) {
        array_splice($suggestions, 1, 0, 'block__block_content_' . $variables['elements']['content']['#block_content']->bundle());
      }
    }
Production build 0.69.0 2024