Changeset 55868

Timestamp:

05/30/2023 02:11:46 PM (3 years ago)

Author:

SergeyBiryukov

Message:

Docs: Add a @since tag for the pre_wp_setup_nav_menu_item filter.

Includes moving the unit test next to the other wp_setup_nav_menu_item() tests and using the MockAction class to confirm that the filter runs.

Follow-up to [55867].

Props TobiasBg.
Fixes #56577.

Location:

trunk

Files:

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

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

@@ -823 +823 @@
 
         /**
-         * Short-circuit the wp_setup_nav_menu_item() output.
+         * Filters whether to short-circuit the wp_setup_nav_menu_item() output.
          *
          * Returning a non-null value from the filter will short-circuit wp_setup_nav_menu_item(),
-         * and return that value.
+         * returning that value instead.
+         *
+         * @since 6.3.0
          *
          * @param object|null $modified_menu_item Modified menu item. Default null.

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

@@ -593 +593 @@
 
         /**
+         * @ticket 56577
+         */
+        public function test_wp_setup_nav_menu_item_short_circuit_filter() {
+                $post_id = self::factory()->post->create();
+
+                $menu_item_id = wp_update_nav_menu_item(
+                        $this->menu_id,
+                        0,
+                        array(
+                                'menu-item-type'      => 'post_type',
+                                'menu-item-object'    => 'post',
+                                'menu-item-object-id' => $post_id,
+                                'menu-item-status'    => 'publish',
+                        )
+                );
+
+                $filter = new MockAction();
+                add_filter( 'pre_wp_setup_nav_menu_item', array( &$filter, 'filter' ) );
+
+                wp_setup_nav_menu_item( get_post( $menu_item_id ) );
+
+                $this->assertSame( 1, $filter->get_call_count() );
+        }
+
+        /**
          * @ticket 35206
          */
@@ -1345 +1370 @@
                 $this->assertEqualsWithDelta( strtotime( gmdate( 'Y-m-d H:i:s' ) ), strtotime( $post->post_date ), 2, 'The dates should be equal' );
         }
-
-        /**
-         * @ticket 56577
-         */
-        public function test_nav_menu_item_short_circuit_filter() {
-                // Create a nav menu item.
-                $menu_item_args = array(
-                        'menu-item-type'   => 'custom',
-                        'menu-item-title'  => 'Wordpress.org',
-                        'menu-item-url'    => 'http://wordpress.org',
-                        'menu-item-status' => 'publish',
-                );
-
-                $custom_item_id = wp_update_nav_menu_item( 0, 0, $menu_item_args );
-
-                $pre_setup_callback = function() {
-                        return '--empty nav menu item--';
-                };
-
-                add_filter( 'pre_wp_setup_nav_menu_item', $pre_setup_callback );
-
-                // Confirm the short-circuit.
-                $custom_item = wp_setup_nav_menu_item( get_post( $custom_item_id ) );
-                $this->assertSame( '--empty nav menu item--', $custom_item );
-
-                remove_filter( 'pre_wp_setup_nav_menu_item', $pre_setup_callback );
-        }
-
 }