Ticket #39776: 39776.9.diff

src/wp-admin/includes/plugin.php

@@ -1338 +1338 @@
  *                              and only include lowercase alphanumeric, dashes, and underscores characters
  *                              to be compatible with sanitize_key().
  * @param callable $function    The function to be called to output the content for this page.
+ * @param int      $position    The position order in the menu where this item should appear.
+ *
  * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
  */
-function add_submenu_page( $parent_slug, $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
+function add_submenu_page( $parent_slug, $page_title, $menu_title, $capability, $menu_slug, $function = '', $position = null ) {
         global $submenu, $menu, $_wp_real_parent_file, $_wp_submenu_nopriv,
                 $_registered_pages, $_parent_pages;
 
@@ -1370 +1372 @@
                 }
         }
 
-        $submenu[ $parent_slug ][] = array( $menu_title, $capability, $menu_slug, $page_title );
+        $new_sub_menu = array( $menu_title, $capability, $menu_slug, $page_title );
+        if ( null === $position ) {
+                $submenu[ $parent_slug ][] = $new_sub_menu;
+        } else {
+                // If position is equal or higher than the number of items in the array, append the submenu.
+                if ( $position >= count( $submenu[ $parent_slug ] ) ) {
+                        $submenu[ $parent_slug ][] = $new_sub_menu;
+                } else {
+                        // Test for a negative position.
+                        $position = max( $position, 0 );
+                        if ( 0 === $position ) {
+                                // For negative or `0` positions, prepend the submenu.
+                                array_unshift( $submenu[ $parent_slug ], $new_sub_menu );
+                        } else {
+                                // Grab all of the items before the insertion point.
+                                $before_items = array_slice( $submenu[ $parent_slug ], 0, $position, true );
+                                // Grab all of the items after the insertion point.
+                                $after_items = array_slice( $submenu[ $parent_slug ], $position, null, true );
+                                // Add the new item.
+                                $before_items[] = $new_sub_menu;
+                                // Merge the items.
+                                $submenu[ $parent_slug ] = array_merge( $before_items, $after_items );
+                        }
+                }
+        }
+        // Sort the parent array
+        ksort( $submenu[ $parent_slug ] );
 
         $hookname = get_plugin_page_hookname( $menu_slug, $parent_slug );
         if ( ! empty( $function ) && ! empty( $hookname ) ) {
@@ -1409 +1437 @@
  * @param string   $capability The capability required for this menu to be displayed to the user.
  * @param string   $menu_slug  The slug name to refer to this menu by (should be unique for this menu).
  * @param callable $function   The function to be called to output the content for this page.
+ * @param int      $position   The position in the menu order this one should appear.
  * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
  */
-function add_management_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
-        return add_submenu_page( 'tools.php', $page_title, $menu_title, $capability, $menu_slug, $function );
+function add_management_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $position = null ) {
+        return add_submenu_page( 'tools.php', $page_title, $menu_title, $capability, $menu_slug, $function, $position );
 }
 
 /**
@@ -1431 +1460 @@
  * @param string   $capability The capability required for this menu to be displayed to the user.
  * @param string   $menu_slug  The slug name to refer to this menu by (should be unique for this menu).
  * @param callable $function   The function to be called to output the content for this page.
+ * @param int      $position   The position in the menu order this one should appear.
  * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
  */
-function add_options_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
-        return add_submenu_page( 'options-general.php', $page_title, $menu_title, $capability, $menu_slug, $function );
+function add_options_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $position = null  ) {
+        return add_submenu_page( 'options-general.php', $page_title, $menu_title, $capability, $menu_slug, $function, $position );
 }
 
 /**
@@ -1453 +1483 @@
  * @param string   $capability The capability required for this menu to be displayed to the user.
  * @param string   $menu_slug  The slug name to refer to this menu by (should be unique for this menu).
  * @param callable $function   The function to be called to output the content for this page.
+ * @param int      $position   The position in the menu order this one should appear.
  * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
  */
-function add_theme_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
-        return add_submenu_page( 'themes.php', $page_title, $menu_title, $capability, $menu_slug, $function );
+function add_theme_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $position = null ) {
+        return add_submenu_page( 'themes.php', $page_title, $menu_title, $capability, $menu_slug, $function, $position );
 }
 
 /**
@@ -1475 +1506 @@
  * @param string   $capability The capability required for this menu to be displayed to the user.
  * @param string   $menu_slug  The slug name to refer to this menu by (should be unique for this menu).
  * @param callable $function   The function to be called to output the content for this page.
+ * @param int      $position   The position in the menu order this one should appear.
  * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
  */
-function add_plugins_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
-        return add_submenu_page( 'plugins.php', $page_title, $menu_title, $capability, $menu_slug, $function );
+function add_plugins_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $position = null ) {
+        return add_submenu_page( 'plugins.php', $page_title, $menu_title, $capability, $menu_slug, $function, $position );
 }
 
 /**
@@ -1497 +1529 @@
  * @param string   $capability The capability required for this menu to be displayed to the user.
  * @param string   $menu_slug  The slug name to refer to this menu by (should be unique for this menu).
  * @param callable $function   The function to be called to output the content for this page.
+ * @param int      $position   The position in the menu order this one should appear.
  * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
  */
-function add_users_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
-        if ( current_user_can( 'edit_users' ) ) {
+
+function add_users_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $position = null ) {
+        if ( current_user_can('edit_users') ) {
                 $parent = 'users.php';
         } else {
                 $parent = 'profile.php';
         }
-        return add_submenu_page( $parent, $page_title, $menu_title, $capability, $menu_slug, $function );
+        return add_submenu_page( $parent, $page_title, $menu_title, $capability, $menu_slug, $function, $position );
 }
 /**
  * Add submenu page to the Dashboard main menu.
@@ -1523 +1557 @@
  * @param string   $capability The capability required for this menu to be displayed to the user.
  * @param string   $menu_slug  The slug name to refer to this menu by (should be unique for this menu).
  * @param callable $function   The function to be called to output the content for this page.
+ * @param int      $position   The position in the menu order this one should appear.
  * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
  */
-function add_dashboard_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
-        return add_submenu_page( 'index.php', $page_title, $menu_title, $capability, $menu_slug, $function );
+function add_dashboard_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $position = null ) {
+        return add_submenu_page( 'index.php', $page_title, $menu_title, $capability, $menu_slug, $function, $position );
 }
 
 /**
@@ -1545 +1580 @@
  * @param string   $capability The capability required for this menu to be displayed to the user.
  * @param string   $menu_slug  The slug name to refer to this menu by (should be unique for this menu).
  * @param callable $function   The function to be called to output the content for this page.
+ * @param int      $position   The position in the menu order this one should appear.
  * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
  */
-function add_posts_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
-        return add_submenu_page( 'edit.php', $page_title, $menu_title, $capability, $menu_slug, $function );
+function add_posts_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $position = null ) {
+        return add_submenu_page( 'edit.php', $page_title, $menu_title, $capability, $menu_slug, $function, $position );
 }
 
 /**
@@ -1567 +1603 @@
  * @param string   $capability The capability required for this menu to be displayed to the user.
  * @param string   $menu_slug  The slug name to refer to this menu by (should be unique for this menu).
  * @param callable $function   The function to be called to output the content for this page.
+ * @param int      $position   The position in the menu order this one should appear.
  * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
  */
-function add_media_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
-        return add_submenu_page( 'upload.php', $page_title, $menu_title, $capability, $menu_slug, $function );
+function add_media_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $position = null ) {
+        return add_submenu_page( 'upload.php', $page_title, $menu_title, $capability, $menu_slug, $function, $position );
 }
 
 /**
@@ -1589 +1626 @@
  * @param string   $capability The capability required for this menu to be displayed to the user.
  * @param string   $menu_slug  The slug name to refer to this menu by (should be unique for this menu).
  * @param callable $function   The function to be called to output the content for this page.
+ * @param int      $position   The position in the menu order this one should appear.
  * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
  */
-function add_links_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
-        return add_submenu_page( 'link-manager.php', $page_title, $menu_title, $capability, $menu_slug, $function );
+function add_links_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $position = null ) {
+        return add_submenu_page( 'link-manager.php', $page_title, $menu_title, $capability, $menu_slug, $function, $position );
 }
 
 /**
@@ -1611 +1649 @@
  * @param string   $capability The capability required for this menu to be displayed to the user.
  * @param string   $menu_slug  The slug name to refer to this menu by (should be unique for this menu).
  * @param callable $function   The function to be called to output the content for this page.
+ * @param int      $position   The position in the menu order this one should appear.
  * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
  */
-function add_pages_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
-        return add_submenu_page( 'edit.php?post_type=page', $page_title, $menu_title, $capability, $menu_slug, $function );
+function add_pages_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $position = null ) {
+        return add_submenu_page( 'edit.php?post_type=page', $page_title, $menu_title, $capability, $menu_slug, $function, $position);
 }
 
 /**
@@ -1633 +1672 @@
  * @param string   $capability The capability required for this menu to be displayed to the user.
  * @param string   $menu_slug  The slug name to refer to this menu by (should be unique for this menu).
  * @param callable $function   The function to be called to output the content for this page.
+ * @param int      $position   The position in the menu order this one should appear.
  * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
  */
-function add_comments_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
-        return add_submenu_page( 'edit-comments.php', $page_title, $menu_title, $capability, $menu_slug, $function );
+function add_comments_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $position = null ) {
+        return add_submenu_page( 'edit-comments.php', $page_title, $menu_title, $capability, $menu_slug, $function, $position );
 }
 
 /**

tests/phpunit/tests/admin/includesPlugin.php

@@ -57 +57 @@
                 wp_set_current_user( $current_user );
         }
 
+        /**
+         * Tests the priority parameter.
+         *
+         * @ticket 39776
+         * @covers ::add_submenu_page
+         *
+         * @param int $priority          The position of the new item.
+         * @param int $expected_position Where the new item is expected to appear.
+         * @dataProvider data_submenu_priority
+         */
+        function test_submenu_priority( $priority, $expected_position  ) {
+                global $submenu;
+                $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.
+                $parent = add_menu_page( 'Test Toplevel', 'Test Toplevel', 'manage_options', 'mt-top-level-handle', 'mt_toplevel_page' );
+                foreach ( $this->submenus_to_add() as $menu ) {
+                        add_submenu_page( $parent, $menu[0], $menu[1], $menu[2], $menu[3], $menu[4] );
+                }
+
+                // Insert the new page.
+                add_submenu_page( $parent, 'New Page', 'New Page', 'manage_options', 'custom-position', 'custom_pos' , $priority );
+                wp_set_current_user( $current_user );
+
+                // Clean up the temporary user.
+                wp_delete_user( $admin_user );
+
+                $this->assertSame( 'custom-position', $submenu[ $parent ][ $expected_position ][2] );
+        }
+
+        /**
+         * Helper to store the menus to add so getting the length is programmatically done.
+         * @since 5.3.0
+         *
+         * @return array
+         */
+        function submenus_to_add() {
+                return array(
+                        array( 'Submenu Priority', 'Submenu Priority', 'manage_options', 'sub-page', '' ),
+                        array( 'Submenu Priority 2', 'Submenu Priority 2', 'manage_options', 'sub-page2', '' ),
+                        array( 'Submenu Priority 3', 'Submenu Priority 3', 'manage_options', 'sub-page3', '' ),
+                        array( 'Submenu Priority 4', 'Submenu Priority 4', 'manage_options', 'sub-page4', '' ),
+                        array( 'Submenu Priority 5', 'Submenu Priority 5', 'manage_options', 'sub-page5', '' ),
+                );
+        }
+        /**
+         * Data provider for the above priority parameter tests.
+         * @return array
+         */
+        function data_submenu_priority() {
+                $menu_count = count( $this->submenus_to_add() );
+                return array(
+                        array( null, $menu_count ),        // Insert at the end of the menu if null is passed. Default behaviour.
+                        array( 0, 0 ),                     // Insert at the beginning of the menu if 0 is passed.
+                        array( -1, 0 ),                    // Negative numbers are treated the same as passing 0.
+                        array( -7, 0 ),                    // Negative numbers are treated the same as passing 0.
+                        array( 1, 1 ),                     // Insert as the second item.
+                        array( 3, 3 ),                     // Insert as the 4th item.
+                        array( $menu_count, $menu_count ), // Numbers equal to the number of items are added at the end.
+                        array( 123456, $menu_count )       // Numbers higher than the number of items are added at the end.
+                );
+        }
+
         function test_is_plugin_active_true() {
                 activate_plugin( 'hello.php' );
                 $test = is_plugin_active( 'hello.php' );