Change record status: 
Project: 
Introduced in branch: 
9.1.x
Introduced in version: 
9.1.2
Description: 

As of the Patternkit 9.1.2 release, support for creating and using reusable blocks from Patternkit patterns is no longer supported. This functionality will be removed altogether in the 9.2.0 release.

When upgrading to the 9.1.2 release, support for reusable blocks will be disabled by default. This includes the creation of new ones or the usage of existing ones. To support a migration period before the functionality is removed altogether, this may be reversed to enable the functionality on a site by adding the following to your services.yml file:

parameters:
  patternkit.config:
    enable_reusable_blocks: true

Assuming the new enable_reusable_blocks service parameter is not set or is explicitly set to FALSE,

  • Reusable block derivatives will not load in order do address the originally reported performance issue
  • The following routes and related pages are no longer accessible or shown in menus:
    • /admin/structure/block/patternkit
    • /patternkit_block/{patternkit_block}
    • /patternkit_block/{patternkit_block}/edit
    • /patternkit_block/{patternkit_block}/delete
    • /patternkit_block/add
    • /patternkit_block/add/{pattern_id}
  • Existing reusable blocks originally created through the layout builder interface and placed in layouts should continue to render as expected
  • Existing reusable blocks originally created through the Block Structure > Patternkit Library interface and placed in layouts will not render
  • A status warning has been added to the requirements page if reusable blocks existing within the database

Migration

This update does not remove any data from the database. All existing reusable blocks and the related data remain available even if they are not loaded for placement. The related fields will be removed as part of #3587730: Remove reusable block support in 9.2.0 with migration tooling for the 9.2.0 release.

Update: This change record previously stated incorrectly that this deprecated functionality would be removed as part of the 9.3.0 release. That has been corrected to target the 9.2.0 release via issue #3587730: Remove reusable block support in 9.2.0 with migration tooling.

The original issue implementing this removal, #3511525: Remove the derivatives for loading reusable patterns, was implemented targeting the 9.1.3 release by mistake and has since been reverted and retargeted as part of #3587714: Revert Reusable Block Support Removal Until Later Release.

Impacts: 
Site builders, administrators, editors
Module developers