' . t('About') . ''; $output .= '
' . t('The Menu UI module provides an interface for managing menus. A menu is a hierarchical collection of links, which can be within or external to the site, generally used for navigation. For more information, see the online documentation for the Menu UI module.', [':menu' => 'https://www.drupal.org/documentation/modules/menu/']) . '
'; $output .= '' . t('You can enable the newly-created block for this menu on the Block layout page.', [':blocks' => Url::fromRoute('block.admin_display')->toString()]) . '
'; } elseif ($route_name == 'entity.menu.collection' && \Drupal::moduleHandler()->moduleExists('block') && \Drupal::currentUser()->hasPermission('administer blocks')) { return '' . t('Each menu has a corresponding block that is managed on the Block layout page.', [':blocks' => Url::fromRoute('block.admin_display')->toString()]) . '
'; } } /** * Implements hook_entity_type_build(). */ function menu_ui_entity_type_build(array &$entity_types) { /** @var $entity_types \Drupal\Core\Entity\EntityTypeInterface[] */ $entity_types['menu'] ->setFormClass('add', 'Drupal\menu_ui\MenuForm') ->setFormClass('edit', 'Drupal\menu_ui\MenuForm') ->setFormClass('delete', 'Drupal\menu_ui\Form\MenuDeleteForm') ->setListBuilderClass('Drupal\menu_ui\MenuListBuilder') ->setLinkTemplate('add-form', '/admin/structure/menu/add') ->setLinkTemplate('delete-form', '/admin/structure/menu/manage/{menu}/delete') ->setLinkTemplate('edit-form', '/admin/structure/menu/manage/{menu}') ->setLinkTemplate('add-link-form', '/admin/structure/menu/manage/{menu}/add') ->setLinkTemplate('collection', '/admin/structure/menu'); if (isset($entity_types['node'])) { $entity_types['node']->addConstraint('MenuSettings', []); } } /** * Implements hook_block_view_BASE_BLOCK_ID_alter() for 'system_menu_block'. */ function menu_ui_block_view_system_menu_block_alter(array &$build, BlockPluginInterface $block) { if ($block->getBaseId() == 'system_menu_block') { $menu_name = $block->getDerivativeId(); $build['#contextual_links']['menu'] = [ 'route_parameters' => ['menu' => $menu_name], ]; } } /** * Helper function to create or update a menu link for a node. * * @param \Drupal\node\NodeInterface $node * Node entity. * @param array $values * Values for the menu link. */ function _menu_ui_node_save(NodeInterface $node, array $values) { /** @var \Drupal\menu_link_content\MenuLinkContentInterface $entity */ if (!empty($values['entity_id'])) { $entity = MenuLinkContent::load($values['entity_id']); if ($entity->isTranslatable()) { if (!$entity->hasTranslation($node->language()->getId())) { $entity = $entity->addTranslation($node->language()->getId(), $entity->toArray()); } else { $entity = $entity->getTranslation($node->language()->getId()); } } } else { // Create a new menu_link_content entity. $entity = MenuLinkContent::create([ 'link' => ['uri' => 'entity:node/' . $node->id()], 'langcode' => $node->language()->getId(), ]); $entity->enabled->value = 1; } $entity->title->value = trim($values['title']); $entity->description->value = trim($values['description']); $entity->menu_name->value = $values['menu_name']; $entity->parent->value = $values['parent']; $entity->weight->value = isset($values['weight']) ? $values['weight'] : 0; $entity->isDefaultRevision($node->isDefaultRevision()); $entity->save(); } /** * Returns the definition for a menu link for the given node. * * @param \Drupal\node\NodeInterface $node * The node entity. * * @return array * An array that contains default values for the menu link form. */ function menu_ui_get_menu_link_defaults(NodeInterface $node) { // Prepare the definition for the edit form. /** @var \Drupal\node\NodeTypeInterface $node_type */ $node_type = $node->type->entity; $menu_name = strtok($node_type->getThirdPartySetting('menu_ui', 'parent', 'main:'), ':'); $defaults = FALSE; if ($node->id()) { $id = FALSE; // Give priority to the default menu $type_menus = $node_type->getThirdPartySetting('menu_ui', 'available_menus', ['main']); if (in_array($menu_name, $type_menus)) { $query = \Drupal::entityQuery('menu_link_content') ->condition('link.uri', 'node/' . $node->id()) ->condition('menu_name', $menu_name) ->sort('id', 'ASC') ->range(0, 1); $result = $query->execute(); $id = (!empty($result)) ? reset($result) : FALSE; } // Check all allowed menus if a link does not exist in the default menu. if (!$id && !empty($type_menus)) { $query = \Drupal::entityQuery('menu_link_content') ->condition('link.uri', 'entity:node/' . $node->id()) ->condition('menu_name', array_values($type_menus), 'IN') ->sort('id', 'ASC') ->range(0, 1); $result = $query->execute(); $id = (!empty($result)) ? reset($result) : FALSE; } if ($id) { $menu_link = MenuLinkContent::load($id); $menu_link = \Drupal::service('entity.repository')->getTranslationFromContext($menu_link); $defaults = [ 'entity_id' => $menu_link->id(), 'id' => $menu_link->getPluginId(), 'title' => $menu_link->getTitle(), 'title_max_length' => $menu_link->getFieldDefinitions()['title']->getSetting('max_length'), 'description' => $menu_link->getDescription(), 'description_max_length' => $menu_link->getFieldDefinitions()['description']->getSetting('max_length'), 'menu_name' => $menu_link->getMenuName(), 'parent' => $menu_link->getParentId(), 'weight' => $menu_link->getWeight(), ]; } } if (!$defaults) { // Get the default max_length of a menu link title from the base field // definition. $field_definitions = \Drupal::service('entity_field.manager')->getBaseFieldDefinitions('menu_link_content'); $max_length = $field_definitions['title']->getSetting('max_length'); $description_max_length = $field_definitions['description']->getSetting('max_length'); $defaults = [ 'entity_id' => 0, 'id' => '', 'title' => '', 'title_max_length' => $max_length, 'description' => '', 'description_max_length' => $description_max_length, 'menu_name' => $menu_name, 'parent' => '', 'weight' => 0, ]; } return $defaults; } /** * Implements hook_form_BASE_FORM_ID_alter() for \Drupal\node\NodeForm. * * Adds menu item fields to the node form. * * @see menu_ui_form_node_form_submit() */ function menu_ui_form_node_form_alter(&$form, FormStateInterface $form_state) { // Generate a list of possible parents (not including this link or descendants). // @todo This must be handled in a #process handler. $node = $form_state->getFormObject()->getEntity(); $defaults = menu_ui_get_menu_link_defaults($node); /** @var \Drupal\node\NodeTypeInterface $node_type */ $node_type = $node->type->entity; /** @var \Drupal\Core\Menu\MenuParentFormSelectorInterface $menu_parent_selector */ $menu_parent_selector = \Drupal::service('menu.parent_form_selector'); $type_menus_ids = $node_type->getThirdPartySetting('menu_ui', 'available_menus', ['main']); if (empty($type_menus_ids)) { return; } /** @var \Drupal\system\MenuInterface[] $type_menus */ $type_menus = Menu::loadMultiple($type_menus_ids); $available_menus = []; foreach ($type_menus as $menu) { $available_menus[$menu->id()] = $menu->label(); } if ($defaults['id']) { $default = $defaults['menu_name'] . ':' . $defaults['parent']; } else { $default = $node_type->getThirdPartySetting('menu_ui', 'parent', 'main:'); } $parent_element = $menu_parent_selector->parentSelectElement($default, $defaults['id'], $available_menus); // If no possible parent menu items were found, there is nothing to display. if (empty($parent_element)) { return; } $form['menu'] = [ '#type' => 'details', '#title' => t('Menu settings'), '#access' => \Drupal::currentUser()->hasPermission('administer menu'), '#open' => (bool) $defaults['id'], '#group' => 'advanced', '#attached' => [ 'library' => ['menu_ui/drupal.menu_ui'], ], '#tree' => TRUE, '#weight' => -2, '#attributes' => ['class' => ['menu-link-form']], ]; $form['menu']['enabled'] = [ '#type' => 'checkbox', '#title' => t('Provide a menu link'), '#default_value' => (int) (bool) $defaults['id'], ]; $form['menu']['link'] = [ '#type' => 'container', '#parents' => ['menu'], '#states' => [ 'invisible' => [ 'input[name="menu[enabled]"]' => ['checked' => FALSE], ], ], ]; // Populate the element with the link data. foreach (['id', 'entity_id'] as $key) { $form['menu']['link'][$key] = ['#type' => 'value', '#value' => $defaults[$key]]; } $form['menu']['link']['title'] = [ '#type' => 'textfield', '#title' => t('Menu link title'), '#default_value' => $defaults['title'], '#maxlength' => $defaults['title_max_length'], ]; $form['menu']['link']['description'] = [ '#type' => 'textfield', '#title' => t('Description'), '#default_value' => $defaults['description'], '#description' => t('Shown when hovering over the menu link.'), '#maxlength' => $defaults['description_max_length'], ]; $form['menu']['link']['menu_parent'] = $parent_element; $form['menu']['link']['menu_parent']['#title'] = t('Parent item'); $form['menu']['link']['menu_parent']['#attributes']['class'][] = 'menu-parent-select'; $form['menu']['link']['weight'] = [ '#type' => 'number', '#title' => t('Weight'), '#default_value' => $defaults['weight'], '#description' => t('Menu links with lower weights are displayed before links with higher weights.'), ]; foreach (array_keys($form['actions']) as $action) { if ($action != 'preview' && isset($form['actions'][$action]['#type']) && $form['actions'][$action]['#type'] === 'submit') { $form['actions'][$action]['#submit'][] = 'menu_ui_form_node_form_submit'; } } $form['#entity_builders'][] = 'menu_ui_node_builder'; } /** * Entity form builder to add the menu information to the node. */ function menu_ui_node_builder($entity_type, NodeInterface $entity, &$form, FormStateInterface $form_state) { $entity->menu = $form_state->getValue('menu'); } /** * Form submission handler for menu item field on the node form. * * @see menu_ui_form_node_form_alter() */ function menu_ui_form_node_form_submit($form, FormStateInterface $form_state) { $node = $form_state->getFormObject()->getEntity(); if (!$form_state->isValueEmpty('menu')) { $values = $form_state->getValue('menu'); if (empty($values['enabled'])) { if ($values['entity_id']) { $entity = MenuLinkContent::load($values['entity_id']); $entity->delete(); } } elseif (trim($values['title'])) { // Decompose the selected menu parent option into 'menu_name' and 'parent', // if the form used the default parent selection widget. if (!empty($values['menu_parent'])) { list($menu_name, $parent) = explode(':', $values['menu_parent'], 2); $values['menu_name'] = $menu_name; $values['parent'] = $parent; } _menu_ui_node_save($node, $values); } } } /** * Implements hook_form_FORM_ID_alter() for \Drupal\node\NodeTypeForm. * * Adds menu options to the node type form. * * @see NodeTypeForm::form() * @see menu_ui_form_node_type_form_submit() */ function menu_ui_form_node_type_form_alter(&$form, FormStateInterface $form_state) { /** @var \Drupal\Core\Menu\MenuParentFormSelectorInterface $menu_parent_selector */ $menu_parent_selector = \Drupal::service('menu.parent_form_selector'); $menu_options = menu_ui_get_menus(); /** @var \Drupal\node\NodeTypeInterface $type */ $type = $form_state->getFormObject()->getEntity(); $form['menu'] = [ '#type' => 'details', '#title' => t('Menu settings'), '#attached' => [ 'library' => ['menu_ui/drupal.menu_ui.admin'], ], '#group' => 'additional_settings', ]; $form['menu']['menu_options'] = [ '#type' => 'checkboxes', '#title' => t('Available menus'), '#default_value' => $type->getThirdPartySetting('menu_ui', 'available_menus', ['main']), '#options' => $menu_options, '#description' => t('The menus available to place links in for this content type.'), ]; // @todo See if we can avoid pre-loading all options by changing the form or // using a #process callback. https://www.drupal.org/node/2310319 // To avoid an 'illegal option' error after saving the form we have to load // all available menu parents. Otherwise, it is not possible to dynamically // add options to the list using ajax. $options_cacheability = new CacheableMetadata(); $options = $menu_parent_selector->getParentSelectOptions('', NULL, $options_cacheability); $form['menu']['menu_parent'] = [ '#type' => 'select', '#title' => t('Default parent item'), '#default_value' => $type->getThirdPartySetting('menu_ui', 'parent', 'main:'), '#options' => $options, '#description' => t('Choose the menu item to be the default parent for a new link in the content authoring form.'), '#attributes' => ['class' => ['menu-title-select']], ]; $options_cacheability->applyTo($form['menu']['menu_parent']); $form['#validate'][] = 'menu_ui_form_node_type_form_validate'; $form['#entity_builders'][] = 'menu_ui_form_node_type_form_builder'; } /** * Validate handler for forms with menu options. * * @see menu_ui_form_node_type_form_alter() */ function menu_ui_form_node_type_form_validate(&$form, FormStateInterface $form_state) { $available_menus = array_filter($form_state->getValue('menu_options')); // If there is at least one menu allowed, the selected item should be in // one of them. if (count($available_menus)) { $menu_item_id_parts = explode(':', $form_state->getValue('menu_parent')); if (!in_array($menu_item_id_parts[0], $available_menus)) { $form_state->setErrorByName('menu_parent', t('The selected menu item is not under one of the selected menus.')); } } else { $form_state->setValue('menu_parent', ''); } } /** * Entity builder for the node type form with menu options. * * @see menu_ui_form_node_type_form_alter() */ function menu_ui_form_node_type_form_builder($entity_type, NodeTypeInterface $type, &$form, FormStateInterface $form_state) { $type->setThirdPartySetting('menu_ui', 'available_menus', array_values(array_filter($form_state->getValue('menu_options')))); $type->setThirdPartySetting('menu_ui', 'parent', $form_state->getValue('menu_parent')); } /** * Return an associative array of the custom menus names. * * @param bool $all * (optional) If FALSE return only user-added menus, or if TRUE also include * the menus defined by the system. Defaults to TRUE. * * @return array * An array with the machine-readable names as the keys, and human-readable * titles as the values. */ function menu_ui_get_menus($all = TRUE) { if ($custom_menus = Menu::loadMultiple()) { if (!$all) { $custom_menus = array_diff_key($custom_menus, menu_list_system_menus()); } foreach ($custom_menus as $menu_name => $menu) { $custom_menus[$menu_name] = $menu->label(); } asort($custom_menus); } return $custom_menus; } /** * Implements hook_preprocess_HOOK() for block templates. */ function menu_ui_preprocess_block(&$variables) { if ($variables['configuration']['provider'] == 'menu_ui') { $variables['attributes']['role'] = 'navigation'; } } /** * Implements hook_system_breadcrumb_alter(). */ function menu_ui_system_breadcrumb_alter(Breadcrumb $breadcrumb, RouteMatchInterface $route_match, array $context) { // Custom breadcrumb behavior for editing menu links, we append a link to // the menu in which the link is found. if (($route_match->getRouteName() == 'menu_ui.link_edit') && $menu_link = $route_match->getParameter('menu_link_plugin')) { if (($menu_link instanceof MenuLinkInterface)) { // Add a link to the menu admin screen. $menu = Menu::load($menu_link->getMenuName()); $breadcrumb->addLink(Link::createFromRoute($menu->label(), 'entity.menu.edit_form', ['menu' => $menu->id()])); } } }