SHS-6009: Remove Visibility and Region fields from the Social Media footer block for Site Editors

[codechefmarc]

Summary

When editing the social media footer block, site managers will no longer see the "Visibility" and "Region" fields. Developer roles will still see these fields.

Need Review By (Date)

2025-01-15

Urgency

low

Steps to Test

1. Login to the site as a Developer
2. Add a social media block to the system (typically in the footer)
3. Verify that the Visibility and Region fields are present

5. Add in a link and then save the block
6. Masquerade as a site manager (Lindsay is usually our test user for this case)

8. Go the home page
9. Hover over the social media block and click the pencil icon, then clock "Edit Social Media block"

10. Verify that as a site manager role, the Visibility and Region fields are no longer visible

Review Tasks

Backend / Functional Validation

Code

• Are the naming conventions following our standards?
• Are PHP functions and variables in snake_case and not camelCase?
• Does Drupal code follow Drupal Coding Standards?
• Does the code have sufficient inline comments?
• Is there anything in this code that would be hidden or hard to discover through the UI?
• Are there any code smells?
• Are tests provided?

Code security

• Is all user input properly sanitized when rendered?
• Any obvious security flaws or new areas for attack?

General

• Is there anything included in this PR that is not related to the problem it is trying to solve?
• Is the approach to the problem appropriate?

---

• To see the specific tasks where the Asana app for GitHub is being used, see below:
  • https://app.asana.com/0/0/1209207583801214

[callinmullaney]

@codechefmarc Nice work! Confirming that I no longer see these visibility regions for non-administrator roles.

[callinmullaney]

@ahughes3 Functional tests pass and the code looks good to me. Kicking this over to you for confirmation.

[ahughes3]

good to go!

[joegl]

@codechefmarc Can this be done in the block plugin itself without using a hook?

suhumsci/docroot/modules/humsci/hs_blocks/src/Plugin/Block/SocialMediaBlock.php

Line 67 in 7d6d72b

public function blockForm($form, FormStateInterface $form_state): array {

[codechefmarc]

@codechefmarc Can this be done in the block plugin itself without using a hook?

suhumsci/docroot/modules/humsci/hs_blocks/src/Plugin/Block/SocialMediaBlock.php

Line 67 in 7d6d72b

public function blockForm($form, FormStateInterface $form_state): array {

@joegl - I looked into this and there doesn't appear to be a way to do it via the block plugin we have already. This is because the $form array in the plugin does not have those visibility or region keys like it does on the form alter. There may be a path if we overrode docroot/core/modules/block/src/BlockForm.php (which is where the visibility and region settings ultimately come from) via a ServiceProvider class or something akin to that. However, I believe that would be much more heavy handed than what we came up with the form alter hook. If you want us to pursue this route, let me know, I'm happy to dig deeper.

[joegl]

@codechefmarc Can this be done in the block plugin itself without using a hook?

suhumsci/docroot/modules/humsci/hs_blocks/src/Plugin/Block/SocialMediaBlock.php

Line 67 in 7d6d72b

public function blockForm($form, FormStateInterface $form_state): array {

@joegl - I looked into this and there doesn't appear to be a way to do it via the block plugin we have already. This is because the $form array in the plugin does not have those visibility or region keys like it does on the form alter. There may be a path if we overrode docroot/core/modules/block/src/BlockForm.php (which is where the visibility and region settings ultimately come from) via a ServiceProvider class or something akin to that. However, I believe that would be much more heavy handed than what we came up with the form alter hook. If you want us to pursue this route, let me know, I'm happy to dig deeper.

Nope, that works for me 👍 I'd always prefer using OOP instead of a hook in a .module file, but that's not always possible.