Changeset 52569

Timestamp:

01/12/2022 11:23:41 PM (3 years ago)

Author:

audrasjb

Message:

Administration: Ensure an integer is used for menu priority in add_menu_page().

This change adds a verification of the $position parameter in add_menu_page() to ensure an integer is used. If not, the function informs developers of the wrong parameter type via a _doing_it_wrong message. This brings consistency with a similar check used in add_submenu_page().

This change also typecasts any floating number to string to ensure that in case a float value was passed, at least it doesn't override existing menus.

Follow-up to [46570].

Props kirtan95.
Fixes #54798. See #48249.

Location:

trunk

Files:

• src/wp-admin/includes/plugin.php (modified) (1 diff)
• tests/phpunit/tests/admin/includesPlugin.php (modified) (2 diffs)

trunk/src/wp-admin/includes/plugin.php

@@ -1330 +1330 @@
         $menu[ "$position" ] = $new_menu;
     } else {
+        if ( ! is_int( $position ) ) {
+            _doing_it_wrong(
+                __FUNCTION__,
+                sprintf(
+                /* translators: %s: add_submenu_page() */
+                    __( 'The seventh parameter passed to %s should be an integer representing menu position.' ),
+                    '<code>add_menu_page()</code>'
+                ),
+                '6.0.0'
+            );
+            // If the position is not a string (i.e. float), convert it to string.
+            if ( ! is_string( $position ) ) {
+                $position = (string) $position;
+            }
+        }
         $menu[ $position ] = $new_menu;
     }

trunk/tests/phpunit/tests/admin/includesPlugin.php

@@ -297 +297 @@
 
     /**
-     * Passing a string as position will fail.
+     * Passing a string as position will fail in submenu.
      *
      * @ticket 48599
      */
-    public function test_passing_string_as_position_fires_doing_it_wrong() {
+    public function test_passing_string_as_position_fires_doing_it_wrong_submenu() {
         $this->setExpectedIncorrectUsage( 'add_submenu_page' );
         global $submenu, $menu;
@@ -325 +325 @@
     }
 
+    /**
+     * Passing a string as position will fail in menu.
+     *
+     * @ticket 48599
+     */
+    public function test_passing_string_as_position_fires_doing_it_wrong_menu() {
+        $this->setExpectedIncorrectUsage( 'add_menu_page' );
+        global $submenu, $menu;
+
+        // Reset menus.
+        $submenu      = array();
+        $menu         = array();
+        $current_user = get_current_user_id();
+        $admin_user   = self::factory()->user->create( array( 'role' => 'administrator' ) );
+        wp_set_current_user( $admin_user );
+        set_current_screen( 'dashboard' );
+
+        // Setup a menu with some items.
+        add_menu_page( 'Main Menu', 'Main Menu', 'manage_options', 'main_slug', 'main_page_callback', 'icon_url', '1' );
+        add_menu_page( 'Main Menu 1', 'Main Menu 1', 'manage_options', 'main1_slug', 'main1_page_callback', 'icon_url1', 1.5 );
+
+        // Clean up the temporary user.
+        wp_set_current_user( $current_user );
+        wp_delete_user( $admin_user );
+
+        // Verify the menu was inserted.
+        $this->assertSame( 'main_slug', $menu[1][2] );
+        // Verify the menu was inserted correctly on passing float as position.
+        $this->assertSame( 'main1_slug', $menu['1.5'][2] );
+    }
+
     public function test_is_plugin_active_true() {
         activate_plugin( 'hello.php' );