[wp-trac] [WordPress Trac] #57840: Docblock improvements for 6.3

WordPress Trac noreply at wordpress.org
Wed Jun 21 08:16:50 UTC 2023


#57840: Docblock improvements for 6.3
----------------------------+-------------------------------------
 Reporter:  hellofromTonya  |       Owner:  (none)
     Type:  task (blessed)  |      Status:  new
 Priority:  normal          |   Milestone:  6.3
Component:  General         |     Version:
 Severity:  normal          |  Resolution:
 Keywords:  has-patch       |     Focuses:  docs, coding-standards
----------------------------+-------------------------------------

Comment (by audrasjb):

 In [changeset:"55962" 55962]:
 {{{
 #!CommitTicketReference repository="" revision="55962"
 Docs: Add missing param description to `update_menu_item_cache` in
 `wp_get_nav_menu_items()`.

 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.

 This changeset adds `update_menu_item_cache` parameter to
 `wp_get_nav_menu_items()` docblock, and indicates that it is set to `true`
 by default.

 Follow-up to [53504].

 Props audrasjb, matmoe.
 Fixes #58468.
 See #57840.
 }}}

-- 
Ticket URL: <https://core.trac.wordpress.org/ticket/57840#comment:69>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform


More information about the wp-trac mailing list