WordPress.org
Get WordPress

Make WordPress Core


Ignore:
Timestamp:
09/20/2019 02:59:04 PM (6 years ago)
Author:
adamsilverstein
Message:

Menus: add a position argument to add_submenu_page and the helper functions that use it.

Add a position argument to the add_submenu_page function similar to the one already in add_menu_page. When adding sub menus enables setting the position in the sub menu where the item should appear.

In addition, add the position argument to functions that call add_submenu_page under the hood: add_management_page, add_options_page, add_theme_page, add_plugins_page, add_users_page, add_dashboard_page, add_posts_page, add_media_page, add_links_page, add_pages_page and add_comments_page.

Props welcher, birgire, alexvorn2.
Fixes #39776.

File:
1 edited

Legend:

Unmodified
Added
Removed

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

    r45932 r46197  
    12681268 *                               e.g. 'dashicons-chart-pie'.
    12691269 *                             * Pass 'none' to leave div.wp-menu-image empty so an icon can be added via CSS.
    1270  * @param int      $position   The position in the menu order this one should appear.
     1270 * @param int      $position   The position in the menu order this item should appear.
    12711271 * @return string The resulting page's hook_suffix.
    12721272 */
    … …  
    13391339 *                              to be compatible with sanitize_key().
    13401340 * @param callable $function    The function to be called to output the content for this page.
     1341 * @param int      $position    The position in the menu order this item should appear.
     1342 *
    13411343 * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
    13421344 */
    1343 function add_submenu_page( $parent_slug, $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
     1345function add_submenu_page( $parent_slug, $page_title, $menu_title, $capability, $menu_slug, $function = '', $position = null ) {
    13441346    global $submenu, $menu, $_wp_real_parent_file, $_wp_submenu_nopriv,
    13451347        $_registered_pages, $_parent_pages;
    … …  
    13711373    }
    13721374
    1373     $submenu[ $parent_slug ][] = array( $menu_title, $capability, $menu_slug, $page_title );
     1375    $new_sub_menu = array( $menu_title, $capability, $menu_slug, $page_title );
     1376    if ( null === $position ) {
     1377        $submenu[ $parent_slug ][] = $new_sub_menu;
     1378    } else {
     1379        // If position is equal or higher than the number of items in the array, append the submenu.
     1380        if ( $position >= count( $submenu[ $parent_slug ] ) ) {
     1381            $submenu[ $parent_slug ][] = $new_sub_menu;
     1382        } else {
     1383            // Test for a negative position.
     1384            $position = max( $position, 0 );
     1385            if ( 0 === $position ) {
     1386                // For negative or `0` positions, prepend the submenu.
     1387                array_unshift( $submenu[ $parent_slug ], $new_sub_menu );
     1388            } else {
     1389                // Grab all of the items before the insertion point.
     1390                $before_items = array_slice( $submenu[ $parent_slug ], 0, $position, true );
     1391                // Grab all of the items after the insertion point.
     1392                $after_items = array_slice( $submenu[ $parent_slug ], $position, null, true );
     1393                // Add the new item.
     1394                $before_items[] = $new_sub_menu;
     1395                // Merge the items.
     1396                $submenu[ $parent_slug ] = array_merge( $before_items, $after_items );
     1397            }
     1398        }
     1399    }
     1400    // Sort the parent array
     1401    ksort( $submenu[ $parent_slug ] );
    13741402
    13751403    $hookname = get_plugin_page_hookname( $menu_slug, $parent_slug );
    … …  
    14101438 * @param string   $menu_slug  The slug name to refer to this menu by (should be unique for this menu).
    14111439 * @param callable $function   The function to be called to output the content for this page.
     1440 * @param int      $position   The position in the menu order this item should appear.
    14121441 * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
    14131442 */
    1414 function add_management_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
    1415     return add_submenu_page( 'tools.php', $page_title, $menu_title, $capability, $menu_slug, $function );
     1443function add_management_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $position = null ) {
     1444    return add_submenu_page( 'tools.php', $page_title, $menu_title, $capability, $menu_slug, $function, $position );
    14161445}
    14171446
    … …  
    14321461 * @param string   $menu_slug  The slug name to refer to this menu by (should be unique for this menu).
    14331462 * @param callable $function   The function to be called to output the content for this page.
     1463 * @param int      $position   The position in the menu order this item should appear.
    14341464 * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
    14351465 */
    1436 function add_options_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
    1437     return add_submenu_page( 'options-general.php', $page_title, $menu_title, $capability, $menu_slug, $function );
     1466function add_options_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $position = null ) {
     1467    return add_submenu_page( 'options-general.php', $page_title, $menu_title, $capability, $menu_slug, $function, $position );
    14381468}
    14391469
    … …  
    14541484 * @param string   $menu_slug  The slug name to refer to this menu by (should be unique for this menu).
    14551485 * @param callable $function   The function to be called to output the content for this page.
     1486 * @param int      $position   The position in the menu order this item should appear.
    14561487 * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
    14571488 */
    1458 function add_theme_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
    1459     return add_submenu_page( 'themes.php', $page_title, $menu_title, $capability, $menu_slug, $function );
     1489function add_theme_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $position = null ) {
     1490    return add_submenu_page( 'themes.php', $page_title, $menu_title, $capability, $menu_slug, $function, $position );
    14601491}
    14611492
    … …  
    14761507 * @param string   $menu_slug  The slug name to refer to this menu by (should be unique for this menu).
    14771508 * @param callable $function   The function to be called to output the content for this page.
     1509 * @param int      $position   The position in the menu order this item should appear.
    14781510 * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
    14791511 */
    1480 function add_plugins_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
    1481     return add_submenu_page( 'plugins.php', $page_title, $menu_title, $capability, $menu_slug, $function );
     1512function add_plugins_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $position = null ) {
     1513    return add_submenu_page( 'plugins.php', $page_title, $menu_title, $capability, $menu_slug, $function, $position );
    14821514}
    14831515
    … …  
    14981530 * @param string   $menu_slug  The slug name to refer to this menu by (should be unique for this menu).
    14991531 * @param callable $function   The function to be called to output the content for this page.
     1532 * @param int      $position   The position in the menu order this item should appear.
    15001533 * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
    15011534 */
    1502 function add_users_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
     1535
     1536function add_users_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $position = null ) {
    15031537    if ( current_user_can( 'edit_users' ) ) {
    15041538        $parent = 'users.php';
    … …  
    15061540        $parent = 'profile.php';
    15071541    }
    1508     return add_submenu_page( $parent, $page_title, $menu_title, $capability, $menu_slug, $function );
     1542    return add_submenu_page( $parent, $page_title, $menu_title, $capability, $menu_slug, $function, $position );
    15091543}
    15101544/**
    … …  
    15241558 * @param string   $menu_slug  The slug name to refer to this menu by (should be unique for this menu).
    15251559 * @param callable $function   The function to be called to output the content for this page.
     1560 * @param int      $position   The position in the menu order this item should appear.
    15261561 * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
    15271562 */
    1528 function add_dashboard_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
    1529     return add_submenu_page( 'index.php', $page_title, $menu_title, $capability, $menu_slug, $function );
     1563function add_dashboard_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $position = null ) {
     1564    return add_submenu_page( 'index.php', $page_title, $menu_title, $capability, $menu_slug, $function, $position );
    15301565}
    15311566
    … …  
    15461581 * @param string   $menu_slug  The slug name to refer to this menu by (should be unique for this menu).
    15471582 * @param callable $function   The function to be called to output the content for this page.
     1583 * @param int      $position   The position in the menu order this item should appear.
    15481584 * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
    15491585 */
    1550 function add_posts_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
    1551     return add_submenu_page( 'edit.php', $page_title, $menu_title, $capability, $menu_slug, $function );
     1586function add_posts_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $position = null ) {
     1587    return add_submenu_page( 'edit.php', $page_title, $menu_title, $capability, $menu_slug, $function, $position );
    15521588}
    15531589
    … …  
    15681604 * @param string   $menu_slug  The slug name to refer to this menu by (should be unique for this menu).
    15691605 * @param callable $function   The function to be called to output the content for this page.
     1606 * @param int      $position   The position in the menu order this item should appear.
    15701607 * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
    15711608 */
    1572 function add_media_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
    1573     return add_submenu_page( 'upload.php', $page_title, $menu_title, $capability, $menu_slug, $function );
     1609function add_media_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $position = null ) {
     1610    return add_submenu_page( 'upload.php', $page_title, $menu_title, $capability, $menu_slug, $function, $position );
    15741611}
    15751612
    … …  
    15901627 * @param string   $menu_slug  The slug name to refer to this menu by (should be unique for this menu).
    15911628 * @param callable $function   The function to be called to output the content for this page.
     1629 * @param int      $position   The position in the menu order this item should appear.
    15921630 * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
    15931631 */
    1594 function add_links_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
    1595     return add_submenu_page( 'link-manager.php', $page_title, $menu_title, $capability, $menu_slug, $function );
     1632function add_links_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $position = null ) {
     1633    return add_submenu_page( 'link-manager.php', $page_title, $menu_title, $capability, $menu_slug, $function, $position );
    15961634}
    15971635
    … …  
    16121650 * @param string   $menu_slug  The slug name to refer to this menu by (should be unique for this menu).
    16131651 * @param callable $function   The function to be called to output the content for this page.
     1652 * @param int      $position   The position in the menu order this item should appear.
    16141653 * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
    16151654 */
    1616 function add_pages_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
    1617     return add_submenu_page( 'edit.php?post_type=page', $page_title, $menu_title, $capability, $menu_slug, $function );
     1655function add_pages_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $position = null ) {
     1656    return add_submenu_page( 'edit.php?post_type=page', $page_title, $menu_title, $capability, $menu_slug, $function, $position );
    16181657}
    16191658
    … …  
    16341673 * @param string   $menu_slug  The slug name to refer to this menu by (should be unique for this menu).
    16351674 * @param callable $function   The function to be called to output the content for this page.
     1675 * @param int      $position   The position in the menu order this item should appear.
    16361676 * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
    16371677 */
    1638 function add_comments_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
    1639     return add_submenu_page( 'edit-comments.php', $page_title, $menu_title, $capability, $menu_slug, $function );
     1678function add_comments_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $position = null ) {
     1679    return add_submenu_page( 'edit-comments.php', $page_title, $menu_title, $capability, $menu_slug, $function, $position );
    16401680}
    16411681
Note: See TracChangeset for help on using the changeset viewer.