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.



Built from https://develop.svn.wordpress.org/trunk@55962


git-svn-id: http://core.svn.wordpress.org/trunk@55474 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
audrasjb 2023-06-21 08:18:19 +00:00
parent 5433b41a88
commit c96f1a663c
2 changed files with 16 additions and 13 deletions

View File

@ -674,18 +674,21 @@ function _is_valid_nav_menu_item( $item ) {
* @param array $args {
* Optional. Arguments to pass to get_posts().
*
* @type string $order How to order nav menu items as queried with get_posts(). Will be ignored
* if 'output' is ARRAY_A. Default 'ASC'.
* @type string $orderby Field to order menu items by as retrieved from get_posts(). Supply an orderby
* field via 'output_key' to affect the output order of nav menu items.
* Default 'menu_order'.
* @type string $post_type Menu items post type. Default 'nav_menu_item'.
* @type string $post_status Menu items post status. Default 'publish'.
* @type string $output How to order outputted menu items. Default ARRAY_A.
* @type string $output_key Key to use for ordering the actual menu items that get returned. Note that
* that is not a get_posts() argument and will only affect output of menu items
* processed in this function. Default 'menu_order'.
* @type bool $nopaging Whether to retrieve all menu items (true) or paginate (false). Default true.
* @type string $order How to order nav menu items as queried with get_posts().
* Will be ignored if 'output' is ARRAY_A. Default 'ASC'.
* @type string $orderby Field to order menu items by as retrieved from get_posts().
* Supply an orderby field via 'output_key' to affect the
* output order of nav menu items. Default 'menu_order'.
* @type string $post_type Menu items post type. Default 'nav_menu_item'.
* @type string $post_status Menu items post status. Default 'publish'.
* @type string $output How to order outputted menu items. Default ARRAY_A.
* @type string $output_key Key to use for ordering the actual menu items that get
* returned. Note that that is not a get_posts() argument
* and will only affect output of menu items processed in
* this function. Default 'menu_order'.
* @type bool $nopaging Whether to retrieve all menu items (true) or paginate
* (false). Default true.
* @type bool $update_menu_item_cache Whether to update the menu item cache. Default true.
* }
* @return array|false Array of menu items, otherwise false.
*/

View File

@ -16,7 +16,7 @@
*
* @global string $wp_version
*/
$wp_version = '6.3-alpha-55961';
$wp_version = '6.3-alpha-55962';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.