Provide access to protected properties in ConfigureSectionForm through getter methods

Open on Drupal.org →

Created on 5 May 2025, 4 months ago

Problem/Motivation

Currently, the $isUpdate and $delta properties in the ConfigureSectionForm class are marked as protected, and no public getter methods are available to access them.

This becomes problematic in scenarios where developers need to alter the Layout Builder Configure Section form using hook_form_layout_builder_configure_section_alter(). Access to these properties is often necessary to implement custom behavior based on whether the form is in update mode or to determine the section's delta.

Since the properties are protected and not exposed via getters, contrib modules are forced to rely on workarounds to access this information.

This feature request is partially inspired by #3044117

Proposed resolution

Contrib modules resolve these problems using different workarounds:

Layout Builder Lock: #3497055

Layout Builder Extras - Live Update: #3348710

Adding simple public getter methods for $isUpdate and $delta would provide a clean, consistent, and forward-compatible solution that improves DX (developer experience) and avoids the need for fragile or hacky code in contrib or custom modules.

For example, solution from LB Extras - Live Updates: https://git.drupalcode.org/project/layoutbuilder_extras_live_update/-/me...

Remaining tasks

Update ConfigureSectionForm
Update LayoutBuilderTest

✨ Feature request

Status

Active

Version

11.0 🔥

Component

layout_builder.module

Created by

🇺🇦Ukraine Panchuk Volyn, Lutsk

Live updates comments and jobs are added and updated live.

Sign in to follow issues

Merge Requests

!12034Provide access to protected properties in ConfigureSectionForm through getter methods
Open
🇺🇦Ukraine Panchuk
updated 4 months ago

Comments & Activities

Issue created by @Panchuk
Comment 4 months ago →
🇺🇦Ukraine Panchuk Volyn, Lutsk
Comment 4 months ago →
🇺🇦Ukraine Panchuk Volyn, Lutsk
Merge request !12034Issue #3522629: Provide access to protected properties in ConfigureSectionForm through getter methods → (Open) created by Panchuk
Pipeline finished with Success
4 months ago
Total: 690s
#488816
Comment 4 months ago →
🇳🇿New Zealand quietone
@panchuk, thanks for the idea and making a merge request.

If this problem was discovered on a version of Drupal that is not 11.x, add that information in the issue summary and leave the version at 11.x. In Drupal core changes are made on on 11.x (our main development branch) first, and are then back ported as needed according to the Core change policies → . Also mentioned on the version → section of the list of issue fields documentation.

I fixed issues links in the issue summary.
Comment 30 days ago →
🇺🇦Ukraine Panchuk Volyn, Lutsk
Comment 30 days ago →
🇳🇿New Zealand danielveza Brisbane, AU
I don't have any issues with adding these methods if it helps to unblock contrib.

I think we should have a change record to highlight that they're now available. https://www.drupal.org/node/3243396 → could be used as a reference point. We should also update the IS to include the pluginId getter, since that is also being added

contrib.social Blog FAQ Discussions

Production build 0.71.5 2024