Hooks Docs: wp-admin/includes/nav-menu.php

[Faison]

Attached patch has docs for the filters
nav_menu_meta_box_object
nav_menu_items_{$post_type_named}
wp_edit_nav_menu_walker

And actions:
wp_update_nav_menu

[Faison]

The action wp_update_nav_menu is actually a duplicate hook.

[Faison]

I have a quick question: In this file, the filter nav_menu_meta_box_object occurs twice, but with different parameters, should the second occurrence be documented as //duplicate_hook instead of how I have it in my patch?

Thanks,
Faison

[DrewAPicture]

Replying to Faison:

I have a quick question: In this file, the filter nav_menu_meta_box_object occurs twice, but with different parameters, should the second occurrence be documented as //duplicate_hook instead of how I have it in my patch?

Thanks,
Faison

Since actions and filters can be used in multiple places, they still always accept the same things but in different contexts. So in the case of this hook, it accepts an object. It's up to the documentation to spell out what kind of objects it accepts, in this case that would be a post type or taxonomy object.

And since any later uses of the hook will be labeled //duplicate_hook it's a good idea to outline the various contexts in the main docblock. Something like:

@param object $post_type A nav menu meta box object, such as Page, Post, Category, Tag, etc. Accepts a post type or taxonomy object.`

[DrewAPicture]

fix duplicate comment, other wording

[DrewAPicture]

25474.3.diff​ fixes the duplicate comment format and cleans up a bunch of the language for clarity and consistency.

[DrewAPicture]

In 25935:

Inline documentation for hooks in wp-admin/includes/nav-menu.php.

Props Faison.
Fixes #25474.