Issue #3415572 by plopesc, m4olivei, ckrina, catch, penyaskito, quietone:...

Issue #3415572 by plopesc, m4olivei, ckrina, catch, penyaskito, quietone: Adjust how Help link and Content links are removed from the Administration menu for the Navigation bar

core/modules/navigation/navigation.api.php

@@ -88,6 +88,30 @@ function hook_navigation_defaults(): array {
   return $blocks;
 }
 
+/**
+ * Alter the content of a given Navigation menu link tree.
+ *
+ * @param array &$tree
+ *   The Navigation link tree.
+ *
+ * @see \Drupal\navigation\Menu\NavigationMenuLinkTree::transform()
+ */
+function hook_navigation_menu_link_tree_alter(array &$tree): void {
+  foreach ($tree as $key => $item) {
+    // Skip elements where menu is not the 'admin' one.
+    $menu_name = $item->link->getMenuName();
+    if ($menu_name != 'admin') {
+      continue;
+    }
+
+    // Remove unwanted Help menu link.
+    $plugin_id = $item->link->getPluginId();
+    if ($plugin_id == 'help.main') {
+      unset($tree[$key]);
+    }
+  }
+}
+
 /**
  * @} End of "addtogroup hooks".
  */

core/modules/navigation/navigation.services.yml

@@ -28,6 +28,7 @@ services:
         '@router.route_provider',
         '@menu.active_trail',
         '@callable_resolver',
+        '@module_handler',
       ]
 
   navigation.entity_route_helper:

core/modules/navigation/src/Hook/NavigationHooks.php

@@ -152,8 +152,6 @@ public function menuLinksDiscoveredAlter(&$links): void {
     $navigation_links = \Drupal::classResolver(NavigationContentLinks::class);
     assert($navigation_links instanceof NavigationContentLinks);
     $navigation_links->addMenuLinks($links);
-    $navigation_links->removeAdminContentLink($links);
-    $navigation_links->removeHelpLink($links);
   }
 
   /**
@@ -291,4 +289,24 @@ public function modulesInstalled(array $modules, bool $is_syncing): void {
     }
   }
 
+  /**
+   * Implements hook_navigation_menu_link_tree_alter().
+   */
+  #[Hook('navigation_menu_link_tree_alter')]
+  public function navigationMenuLinkTreeAlter(array &$tree): void {
+    foreach ($tree as $key => $item) {
+      // Skip elements where menu is not the 'admin' one.
+      $menu_name = $item->link->getMenuName();
+      if ($menu_name != 'admin') {
+        continue;
+      }
+
+      // Remove unwanted Help and Content menu links.
+      $plugin_id = $item->link->getPluginId();
+      if ($plugin_id == 'help.main' || $plugin_id == 'system.admin_content') {
+        unset($tree[$key]);
+      }
+    }
+  }
+
 }

core/modules/navigation/src/Menu/NavigationMenuLinkTree.php

@@ -4,7 +4,13 @@
 
 namespace Drupal\navigation\Menu;
 
+use Drupal\Core\Extension\ModuleHandlerInterface;
+use Drupal\Core\Menu\MenuActiveTrailInterface;
+use Drupal\Core\Menu\MenuLinkManagerInterface;
 use Drupal\Core\Menu\MenuLinkTree;
+use Drupal\Core\Menu\MenuTreeStorageInterface;
+use Drupal\Core\Routing\RouteProviderInterface;
+use Drupal\Core\Utility\CallableResolver;
 
 /**
  * Extends MenuLinkTree to add specific theme suggestions for the navigation.
@@ -13,6 +19,33 @@
  */
 final class NavigationMenuLinkTree extends MenuLinkTree {
 
+  /**
+   * Constructs a \Drupal\navigation\Menu\NavigationMenuLinkTree object.
+   *
+   * @param \Drupal\Core\Menu\MenuTreeStorageInterface $treeStorage
+   *   The menu link tree storage.
+   * @param \Drupal\Core\Menu\MenuLinkManagerInterface $menuLinkManager
+   *   The menu link plugin manager.
+   * @param \Drupal\Core\Routing\RouteProviderInterface $routeProvider
+   *   The route provider to load routes by name.
+   * @param \Drupal\Core\Menu\MenuActiveTrailInterface $menuActiveTrail
+   *   The active menu trail service.
+   * @param \Drupal\Core\Utility\CallableResolver $callableResolver
+   *   The callable resolver.
+   * @param \Drupal\Core\Extension\ModuleHandlerInterface $moduleHandler
+   *   The module handler.
+   */
+  public function __construct(
+    MenuTreeStorageInterface $treeStorage,
+    MenuLinkManagerInterface $menuLinkManager,
+    RouteProviderInterface $routeProvider,
+    MenuActiveTrailInterface $menuActiveTrail,
+    CallableResolver $callableResolver,
+    protected ModuleHandlerInterface $moduleHandler,
+  ) {
+    parent::__construct($treeStorage, $menuLinkManager, $routeProvider, $menuActiveTrail, $callableResolver);
+  }
+
   /**
    * {@inheritdoc}
    */
@@ -47,4 +80,13 @@ public function build(array $tree): array {
     return $build;
   }
 
+  /**
+   * {@inheritdoc}
+   */
+  public function transform(array $tree, array $manipulators) {
+    $tree = parent::transform($tree, $manipulators);
+    $this->moduleHandler->alter('navigation_menu_link_tree', $tree);
+    return $tree;
+  }
+
 }

core/modules/navigation/src/NavigationContentLinks.php

@@ -94,36 +94,6 @@ public function addMenuLinks(array &$links): void {
     ], $links);
   }
 
-  /**
-   * Remove the admin/content link, and any direct children.
-   *
-   * @param array $links
-   *   The array of links being altered.
-   */
-  public function removeAdminContentLink(array &$links): void {
-    unset($links['system.admin_content']);
-
-    // Also remove any links that have set admin/content as their parent link.
-    // They are unsupported by the Navigation module.
-    foreach ($links as $link_name => $link) {
-      if (isset($link['parent']) && $link['parent'] === 'system.admin_content') {
-        // @todo Do we need to make this recursive, and unset children of these
-        // links too?
-        unset($links[$link_name]);
-      }
-    }
-  }
-
-  /**
-   * Remove the help link as render it outside any menu.
-   *
-   * @param array $links
-   *   The array of links being altered.
-   */
-  public function removeHelpLink(array &$links): void {
-    unset($links['help.main']);
-  }
-
   /**
    * Add create links for an entity type.
    *

core/modules/navigation/tests/navigation_test/src/Hook/NavigationTestHooks.php

@@ -84,4 +84,24 @@ public function navigationContentTopAlter(&$content_top): void {
     }
   }
 
+  /**
+   * Implements hook_navigation_menu_link_tree_alter().
+   */
+  #[Hook('navigation_menu_link_tree_alter')]
+  public function navigationMenuLinkTreeAlter(array &$tree): void {
+    foreach ($tree as $key => $item) {
+      // Skip elements where menu is not the 'admin' one.
+      $menu_name = $item->link->getMenuName();
+      // Removes all items from menu1.
+      if ($menu_name == 'menu1') {
+        unset($tree[$key]);
+      }
+
+      // Updates title for items in menu2
+      if ($menu_name == 'menu2') {
+        $item->link->updateLink(['title' => 'New Link Title'], FALSE);
+      }
+    }
+  }
+
 }

core/modules/navigation/tests/src/Kernel/NavigationContentLinksTest.php

@@ -37,7 +37,6 @@ class NavigationContentLinksTest extends KernelTestBase {
     'media_test_source',
     'image',
     'text',
-    'help',
   ];
 
   /**
@@ -119,12 +118,6 @@ public function testNavigationContentLinks(): void {
     $this->assertEquals('view.files.page_1', $links['navigation.files']['route_name']);
     $this->assertEquals('Files', $links['navigation.files']['title']);
 
-    // Assert that the "Help" link is removed from the menu.
-    $this->assertArrayNotHasKey('help.main', $links);
-
-    // Assert that the "Content" link is removed from the menu.
-    $this->assertArrayNotHasKey('system.admin_content', $links);
-
     // Assert that "Blocks" link is not added.
     $this->assertArrayNotHasKey('navigation.blocks', $links);
 

core/modules/navigation/tests/src/Kernel/NavigationMenuLinkTreeTest.php

+<?php
+
+declare(strict_types=1);
+
+namespace Drupal\Tests\navigation\Kernel;
+
+use Drupal\Core\Menu\MenuTreeParameters;
+use Drupal\KernelTests\KernelTestBase;
+use Drupal\navigation\Menu\NavigationMenuLinkTree;
+
+/**
+ * Tests \Drupal\navigation\Menu\NavigationMenuLinkTree.
+ *
+ * @group navigation
+ *
+ * @see \Drupal\navigation\Menu\NavigationMenuLinkTree
+ */
+class NavigationMenuLinkTreeTest extends KernelTestBase {
+
+  /**
+   * The tested navigation menu link tree.
+   *
+   * @var \Drupal\navigation\Menu\NavigationMenuLinkTree
+   */
+  protected NavigationMenuLinkTree $linkTree;
+
+  /**
+   * {@inheritdoc}
+   */
+  protected static $modules = [
+    'field',
+    'layout_builder',
+    'layout_discovery',
+    'link',
+    'menu_link_content',
+    'menu_test',
+    'navigation',
+    'navigation_test',
+    'system',
+    'user',
+  ];
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function setUp(): void {
+    parent::setUp();
+    $this->installEntitySchema('user');
+    $this->installEntitySchema('menu_link_content');
+
+    $this->linkTree = $this->container->get('navigation.menu_tree');
+  }
+
+  /**
+   * Tests the hook_navigation_menu_link_tree_alter logic.
+   */
+  public function testNavigationMenuLinkTreeAlter(): void {
+    /** @var \Drupal\system\MenuStorage $storage */
+    $storage = \Drupal::entityTypeManager()->getStorage('menu');
+    $storage->create(['id' => 'menu1', 'label' => 'Menu 1'])->save();
+    $storage->create(['id' => 'menu2', 'label' => 'Menu 2'])->save();
+
+    \Drupal::entityTypeManager()->getStorage('menu_link_content')->create(['link' => ['uri' => 'internal:/menu_name_test'], 'menu_name' => 'menu1', 'bundle' => 'menu_link_content', 'title' => 'Link test'])->save();
+    \Drupal::entityTypeManager()->getStorage('menu_link_content')->create(['link' => ['uri' => 'internal:/menu_name_test'], 'menu_name' => 'menu1', 'bundle' => 'menu_link_content', 'title' => 'Link test'])->save();
+    \Drupal::entityTypeManager()->getStorage('menu_link_content')->create(['link' => ['uri' => 'internal:/menu_name_test'], 'menu_name' => 'menu2', 'bundle' => 'menu_link_content', 'title' => 'Link test'])->save();
+
+    $output = $this->linkTree->load('menu1', new MenuTreeParameters());
+    $this->assertCount(2, $output);
+    $output = $this->linkTree->transform($output, []);
+    $this->assertCount(0, $output);
+    $output = $this->linkTree->load('menu2', new MenuTreeParameters());
+    $this->assertCount(1, $output);
+    $output = $this->linkTree->transform($output, []);
+    $this->assertCount(1, $output);
+    $item = reset($output);
+    $this->assertSame('New Link Title', $item->link->getTitle());
+  }
+
+}