Make WordPress Core

Opened 14 months ago

Closed 13 months ago

Last modified 13 months ago

#58468 closed defect (bug) (fixed)

Add missing param description to `update_menu_item_cache` in `wp_get_nav_menu_items()`.

Reported by: audrasjb's profile audrasjb Owned by: audrasjb's profile audrasjb
Milestone: 6.3 Priority: normal
Severity: normal Version: 6.1
Component: Menus Keywords: has-patch
Focuses: docs Cc:

Description

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.

Change History (6)

This ticket was mentioned in PR #4558 on WordPress/wordpress-develop by @audrasjb.


14 months ago
#1

  • Keywords has-patch added

#2 @mukesh27
14 months ago

Nice catch @audrasjb. PR look good to me and approved.

#3 @kapilpaul
13 months ago

Thanks for the PR @audrasjb. PR looks good.

#4 @audrasjb
13 months ago

  • Resolution set to fixed
  • Status changed from assigned to closed

In 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.

#6 @audrasjb
13 months ago

#58690 was marked as a duplicate.

Note: See TracTickets for help on using tickets.