Hook Docs: wp-includes/nav-menu.php

[dustyf]

Attached patch has docs for the following filters and actions in wp-includes/nav-menu.php:

FILTERS
wp_get_nav_menus
wp_get_nav_menu_items
nav_menu_attr_title
nav_menu_description
wp_setup_nav_menu_item

ACTIONS
wp_delete_nav_menu
wp_create_nav_menu
wp_update_nav_menu
wp_update_nav_menu_item

[dustyf]

Patch file for wp-includes/nav-menu.php

[DrewAPicture]

Nice, thanks for the patch Dusty. We'll try to get you a review soon.

[DrewAPicture]

Thanks for the patch. Here are some notes on wp-includes-nav-menu.php.diff​:

wp_delete_nav_menu hook:

• Should use a docs-specific variable for the term id, perhaps $term_id

wp_create_nav_menu hook:

• Again, use a docs-specific variable for the first parameter. You could even use $term_id again.
• General rule of thumb in core inline docs is to use 'ID', instead 'id' (in most cases).

wp_update_nav_menu hook:

• s/id/ID

wp_update_nav_menu_item hook:

• Add a standalone @see wp_update_nav_menu_items() between the @since and @param lines (this is actually a reference for the third parameter, $args, inherited from the parent function.

wp_get_nav_menus filter:

• Add an empty line above the docblock
• Maybe add a standalone @see get_terms() line between the @since and @param lines

nav_menu_attr_title filter:

• Use a docs-specific variable for the parameter, maybe $title or $item_title or something

[dustyf]

Inline docs for wp-includes/nav-menu.php take two

[dustyf]

Thanks for the suggestions Drew. I've attached a file with the suggested changes.

[DrewAPicture]

Great, I'll take a look.

[dustyf]

Docs for wp-includes/nav-menu.php take 3

[dustyf]

Fixed a bit of code I forgot to take out before diffing. Use the last one instead.

[kpdesign]

Fourth pass

[kpdesign]

27367.4.diff​ contains changes for language consistency and formatting.

[DrewAPicture]

Final pass.

[DrewAPicture]

27367.diff​ should do it.

[DrewAPicture]

In 27700:

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

Props dustyf, kpdesign.
Fixes #27367.