list of menu item properties in hook_menu_links_discovered_alter() is incomplete

Hi Joachim,

Can you suggest me some things, I am not sure about these.

- load arguments: is this same as drupal 7 load arguments parameter in hook_menu()?
- id: is this the machine name of the menu link?
- metadata: can this be simply saying "metadata about the menu link" ?
- class: is it MenuLinkDefaultForm ?

No guesses for the others.

This hook documentation is wrong in other ways... for instance, there is no return value. It's an alter hook, so you should modify the $links in place.

So, regarding the properties...

This is the method that actually gets the definitions that are passed into this hook:

https://api.drupal.org/api/drupal/core!lib!Drupal!Core!Plugin!Discovery!...

So what is in there is whatever is in the YAML files that define the menu links, plus 'provider' and 'id'.

For documentation on what is supposed to be in menu links YAML, we have
https://api.drupal.org/api/drupal/core!lib!Drupal!Core!Menu!menu.api.php...
and pages on drupal.org that it links to.

So, look there....

So, should I remove @return from this hook and paste all the description in @return above @param?
Because the description is quite helpful to the reader.

I have removed the return doc and added the description to @param description.

Thanks! Yes, that is the correct fix for the @param/@return sections. However, the patch doesn't address the problem in the issue summary yet (the missing properties).

not good at documentation

currently i am working on it ....

let me go through the documentation ....

@Vinay15 As the patch mentioned in the #10 is good to go as the documentation says that the links will be altered based on the function which is mentioned below

function hook_menu_links_discovered_alter(&$links) {

  // Change the weight and title of the user.logout link.
  $links['user.logout']['weight'] = -10;
  $links['user.logout']['title'] = new \Drupal\Core\StringTranslation\TranslatableMarkup('Logout');

  // Conditionally add an additional link with a title that's not translated.
  if (\Drupal::moduleHandler()
    ->moduleExists('search')) {
    $links['menu.api.search'] = array(
      'title' => \Drupal::config('system.site')
        ->get('name'),
      'route_name' => 'menu.api.search',
      'description' => new \Drupal\Core\StringTranslation\TranslatableMarkup('View popular search phrases for this site.'),
      'parent' => 'system.admin_reports',
    );
  }
}

@Vinay15 As the patch mentioned in the #10 is good to go as the documentation says that the links will be altered based on the function which is mentioned below

function hook_menu_links_discovered_alter(&$links) {

  // Change the weight and title of the user.logout link.
  $links['user.logout']['weight'] = -10;
  $links['user.logout']['title'] = new \Drupal\Core\StringTranslation\TranslatableMarkup('Logout');

  // Conditionally add an additional link with a title that's not translated.
  if (\Drupal::moduleHandler()
    ->moduleExists('search')) {
    $links['menu.api.search'] = array(
      'title' => \Drupal::config('system.site')
        ->get('name'),
      'route_name' => 'menu.api.search',
      'description' => new \Drupal\Core\StringTranslation\TranslatableMarkup('View popular search phrases for this site.'),
      'parent' => 'system.admin_reports',
    );
  }
}

Hi @joachim i tried adding the items name but i am not able to describe them (only that they are optional). A small description for each would be helpful to update the patch and close this issue.Thanks

There is fair bit of research that needs to be done in order to document these values. I am removing the novice tag.