Changeset 55867

Timestamp:

05/30/2023 11:19:41 AM (3 years ago)

Author:

azaozz

Message:

Menus: Add a short-circuit filter to wp_setup_nav_menu_item().

Props: davidbinda, ironprogrammer, andizer.
Fixes: #56577.

Location:

trunk

Files:

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

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

@@ -821 +821 @@
  */
 function wp_setup_nav_menu_item( $menu_item ) {
+
+        /**
+         * 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.
+         *
+         * @param object|null $modified_menu_item Modified menu item. Default null.
+         * @param object      $menu_item          The menu item to modify.
+         */
+        $pre_menu_item = apply_filters( 'pre_wp_setup_nav_menu_item', null, $menu_item );
+
+        if ( null !== $pre_menu_item ) {
+                return $pre_menu_item;
+        }
+
         if ( isset( $menu_item->post_type ) ) {
                 if ( 'nav_menu_item' === $menu_item->post_type ) {

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

@@ -1217 +1217 @@
                         )
                 );
-                $post         = get_post( $menu_item_id );
+
+                $post = get_post( $menu_item_id );
                 $this->assertEqualsWithDelta( strtotime( gmdate( 'Y-m-d H:i:s' ) ), strtotime( $post->post_date ), 2, 'The dates should be equal' );
 
@@ -1231 +1232 @@
                         )
                 );
-                $post         = get_post( $menu_item_id );
+
+                $post = get_post( $menu_item_id );
                 $this->assertSame( get_date_from_gmt( $post_date_gmt ), $post->post_date );
 
@@ -1245 +1247 @@
                         )
                 );
-                $post         = get_post( $menu_item_id );
+
+                $post = get_post( $menu_item_id );
                 $this->assertSame( '1970-01-01 00:00:00', $post->post_date );
 
@@ -1259 +1262 @@
                         )
                 );
-                $post         = get_post( $menu_item_id );
+
+                $post = get_post( $menu_item_id );
                 $this->assertSame( $post_date, $post->post_date );
 
@@ -1274 +1278 @@
                         )
                 );
-                $post         = get_post( $menu_item_id );
+
+                $post = get_post( $menu_item_id );
                 $this->assertSame( $post_date, $post->post_date );
 
@@ -1289 +1294 @@
                         )
                 );
-                $post         = get_post( $menu_item_id );
+
+                $post = get_post( $menu_item_id );
                 $this->assertSame( $post_date, $post->post_date );
 
@@ -1303 +1309 @@
                         )
                 );
-                $post         = get_post( $menu_item_id );
+
+                $post = get_post( $menu_item_id );
                 $this->assertEqualsWithDelta( strtotime( gmdate( 'Y-m-d H:i:s' ) ), strtotime( $post->post_date ), 2, 'The dates should be equal' );
 
@@ -1318 +1325 @@
                         )
                 );
-                $post         = get_post( $menu_item_id );
+
+                $post = get_post( $menu_item_id );
                 $this->assertEqualsWithDelta( strtotime( gmdate( 'Y-m-d H:i:s' ) ), strtotime( $post->post_date ), 2, 'The dates should be equal' );
 
@@ -1333 +1341 @@
                         )
                 );
-                $post         = get_post( $menu_item_id );
+
+                $post = get_post( $menu_item_id );
                 $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 );
+        }
+
 }