[wp-trac] [WordPress Trac] #58468: Add missing param description to `update_menu_item_cache` in `wp_get_nav_menu_items()`.

WordPress Trac noreply at wordpress.org
Tue Jun 6 21:07:43 UTC 2023


#58468: Add missing param description to `update_menu_item_cache` in
`wp_get_nav_menu_items()`.
--------------------------+----------------------
 Reporter:  audrasjb      |      Owner:  audrasjb
     Type:  defect (bug)  |     Status:  assigned
 Priority:  normal        |  Milestone:  6.3
Component:  Menus         |    Version:  6.1
 Severity:  normal        |   Keywords:
  Focuses:  docs          |
--------------------------+----------------------
 Because `update_menu_item_cache` parameter doesn't have any description in
 this function, the `wp_get_nav_menu_items()` documentation page on DevHub
 fallbacks to `get_post()` params descriptions… which fallbacks to
 `parse_query()`.

 In `parse_query()`, the `update_menu_item_cache` param is set to `false`
 by default, so `wp_get_nav_menu_items()` ends up with a value of `false`
 by default, which is wrong since `wp_get_nav_menu_items()` overrides this
 parameter to set it to `true` by default.

 Remediation: add `update_menu_item_cache` parameter to
 `wp_get_nav_menu_items()`’s docblock, and indicates that it is set to
 `true` by default.

 See
 https://developer.wordpress.org/reference/functions/wp_get_nav_menu_items/
 (click on the `More Arguments from get_posts( ... $args )` accordion
 link).

 Props @matmoe for reporting this issue in a DevHub comment.

 Issue introduced in [53504]. See #55620.

-- 
Ticket URL: <https://core.trac.wordpress.org/ticket/58468>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform


More information about the wp-trac mailing list