Changeset 53508

Timestamp:

06/15/2022 01:35:28 PM (4 years ago)

Author:

SergeyBiryukov

Message:

REST API: Some documentation and test improvements for update_menu_item_cache():

• Make the function description more specific, for consistency with other similar functions.
• Add a @since note for the $update_menu_item_cache parameter of WP_Query::parse_query().
• Add missing @covers tags for the unit tests.

Follow-up to [53504].

See #55620.

Location:

trunk

Files:

• src/wp-includes/class-wp-query.php (modified) (1 diff)
• src/wp-includes/nav-menu.php (modified) (2 diffs)
• tests/phpunit/tests/post/nav-menu.php (modified) (3 diffs)

trunk/src/wp-includes/class-wp-query.php

@@ -628 +628 @@
          * @since 5.1.0 Introduced the `$meta_compare_key` parameter.
          * @since 5.3.0 Introduced the `$meta_type_key` parameter.
+         * @since 6.1.0 Introduced the `$update_menu_item_cache` parameter.
          *
          * @param string|array $query {

trunk/src/wp-includes/nav-menu.php

@@ -754 +754 @@
 
 /**
- * Prime all linked objects to menu items.
+ * Updates post and term caches for all linked objects for a list of menu items.
  *
  * @since 6.1.0
  *
- * @param WP_Post[] $menu_items Array post objects of menu items.
+ * @param WP_Post[] $menu_items Array of menu item post objects.
  */
 function update_menu_item_cache( $menu_items ) {
@@ -768 +768 @@
                         continue;
                 }
+
                 $object_id = get_post_meta( $menu_item->ID, '_menu_item_object_id', true );
                 $type      = get_post_meta( $menu_item->ID, '_menu_item_type', true );

trunk/tests/phpunit/tests/post/nav-menu.php

@@ -205 +205 @@
         /**
          * @ticket 55620
-         */
-        public function test_update_menu_item_cache_primed_post() {
+         * @covers update_menu_item_cache
+         */
+        public function test_update_menu_item_cache_primed_posts() {
                 $post_id = self::factory()->post->create();
                 wp_update_nav_menu_item(
@@ -230 +231 @@
                 $args = $action->get_args();
                 $last = end( $args );
-                $this->assertEqualSets( array( $post_id ), $last[1], '_prime_post_caches was not executed.' );
+                $this->assertEqualSets( array( $post_id ), $last[1], '_prime_post_caches() was not executed.' );
         }
 
         /**
          * @ticket 55620
+         * @covers update_menu_item_cache
          */
         public function test_update_menu_item_cache_primed_terms() {
@@ -261 +263 @@
                 $args = $action->get_args();
                 $last = end( $args );
-                $this->assertEqualSets( array( $term_id ), $last[1], '_prime_term_caches was not executed.' );
+                $this->assertEqualSets( array( $term_id ), $last[1], '_prime_term_caches() was not executed.' );
         }