Deprecate views_ui_contextual_links_suppress(), views_ui_contextual_links_suppress_push(), views_ui_contextual_links_suppress_pop()

Btw layout builder also using to suppress contextual, so makes sense to have common approach #3028191: When using Layout Builder, remove contextual links for blocks outside of the current layout

#2 Patch Re-rolled for 9.1.x
Please review

Changing deprecation message from Drupal 8.8.0 and will be removed before Drupal 9.0.0 to Drupal 9.1.0 and will be removed before Drupal 10.0.0.

I am not convinced this code even works. The comment says

      // Suppress contextual links of entities within the result set during a
      // Preview.

but if I edit the frontpage view that comes with core, contextual links are still displayed in the preview of any teaser nodes.

I put a breakpoint inside views_ui_contextual_links_suppress() and the push and pop methods are called but views_ui_contextual_links_view_alter() doesn't seem to get called in this context, although it seems like it should because the contextual links are being generated!

Please check.

+++ b/core/includes/bootstrap.inc
@@ -674,7 +675,10 @@ function drupal_static_reset($name = NULL) {
+      @trigger_error('Using drupal_static_reset() with "views_ui_contextual_links_suppress" as parameter is deprecated in Drupal 9.1.0 and will be removed before Drupal 10.0.0. Use \Drupal\views_ui\ViewsUiContextualLinks::reset() instead. See https://www.drupal.org/node/3039250.', E_USER_DEPRECATED);

+++ b/core/modules/views_ui/views_ui.module
@@ -268,39 +269,46 @@ function views_ui_contextual_links_view_alter(&$element, $items) {
+ * @deprecated in Drupal 9.1.0 and will be removed before Drupal 10.0.0. Use
...
+  @trigger_error('views_ui_contextual_links_suppress() is deprecated in Drupal 9.1.0 and will be removed before Drupal 10.0.0. Use \Drupal\views_ui\ViewsUiContextualLinks::isSuppressed() to check if rendering of contextual links is suppressed and \Drupal\views_ui\ViewsUiContextualLinks::setSuppressed() to overwrite the current state. See https://www.drupal.org/node/3039250.', E_USER_DEPRECATED);
...
+ * @deprecated in Drupal 9.1.0 and will be removed before Drupal 10.0.0. Use
...
+  @trigger_error('views_ui_contextual_links_suppress_push() is deprecated in Drupal 9.1.0 and will be removed before Drupal 10.0.0. Use \Drupal\views_ui\ViewsUiContextualLinks::suppress() instead. See https://www.drupal.org/node/3039250.', E_USER_DEPRECATED);
...
+ * @deprecated in Drupal 9.1.0 and will be removed before Drupal 10.0.0. Use
...
+  @trigger_error('views_ui_contextual_links_suppress_pop() is deprecated in Drupal 9.1.0 and will be removed before Drupal 10.0.0. Use \Drupal\views_ui\ViewsUiContextualLinks::render() instead. See https://www.drupal.org/node/3039250.', E_USER_DEPRECATED);

9.4.0 instead of 9.1

Thank you, now only deprecation test is needed

@alex_optim Do not forget to add interdiff https://www.drupal.org/docs/develop/git/using-git-to-contribute-to-drupa...

Added interdiff.

+++ b/core/modules/views_ui/views_ui.module
@@ -268,39 +269,46 @@ function views_ui_contextual_links_view_alter(&$element, $items) {
+  @trigger_error('views_ui_contextual_links_suppress_push() is deprecated in drupal:9.1.0 and is removed from drupal:10.0.0. Use \Drupal\views_ui\ViewsUiContextualLinks::suppress() instead. See https://www.drupal.org/node/3039250', E_USER_DEPRECATED);
...
+ * @deprecated in drupal:9.1.0 and is removed from drupal:10.0.0. Use

should be 10.0.0 and 10.1.0

As far as I can see I don't think any of this code works.

I put breakpoints in:

• ViewUI::renderPreview() - where push and pop are called
• ViewsUIHooks::contextualLinksViewAlter() - where the links are meant to be suppressed
• ContextualLinks::preRenderLinks() - where the alter hook is called from

The push and pop are called, but the hook is never invoked. This is because contextual links don't appear to use the #contextual_links render element any more, but #contextual_links_placeholder instead - adding a breakpoint in ContextualLinksPlaceholder::preRenderPlaceholder() is caught, but that doesn't invoke the alter hook.

Even if this did work, the push and pop are wrapped around the preview time, which only builds a render array; the prerender hook won't be called until later, after the suppression has been popped.

I think we should deprecate these functions entirely, removing all functionality and leaving just stubs that can be removed in a future major.

I searched contrib and only found one call to views_ui_contextual_links_suppress: https://www.drupal.org/project/commerce_invoice_receipt which has no current release.

I think on that alone we can deprecate with no replacement.

I did put breakpoints I saw that contextualLinksViewAlter did get called in the ui, but supress never returned true so we only hit the elseif clause.

I think that is what you are saying is right though.

This is meant to stop contextual links from showing up in the views preview right? When I checked that I do see contextual links in the preview both on this MR and in main so I think this is fine to remove.

Took a quick look, I think we also need a deprecation in bootstrap.inc for the drupal_static call for views_ui_contextual_links_suppress

> Took a quick look, I think we also need a deprecation in bootstrap.inc for the drupal_static call for views_ui_contextual_links_suppress

Do we really need to bother with this? This isn't a cache, it's just a means to carry in-memory-state between multiple functions, nothing anyone should ever need to reset. I'd say skip this, avoids conflicts in there.

I'll defer to you guys here

I checked the CR and updated the IS.

I think deprecating these for removal in 12 is fine since contrib doesn't call them and they have not worked in ages.

Committed and pushed 3742821e2b1 to main and 4b473042d6c to 11.x. Thanks!