[wp-trac] [WordPress Trac] #5001: Admin menu generation sometimes shows wrong page as current

[WordPress Trac]

#5001: Admin menu generation sometimes shows wrong page as current
----------------------------+-----------------------------------------------
 Reporter:  jhodgdon        |       Owner:  anonymous             
     Type:  defect          |      Status:  new                   
 Priority:  normal          |   Milestone:  2.3                   
Component:  Administration  |     Version:  2.3                   
 Severity:  normal          |    Keywords:  admin, menu, has-patch
----------------------------+-----------------------------------------------
 When generating the menus at the top of admin pages, you can create a
 situation where the menu system gets confused about which page is the
 current page.

 The issue comes up when the plugin has both sub-menu pages for built-in
 WordPress menus and its own main menu section, and you add the sub-menu
 pages first in the plugin code.

 The attached plugin (courtesy of Mike Walsh) illustrates the problem:

 (1) Install and activate the plugin.

 (2) Click on the "Menu Tester" link in the top menu line (the URL is
 blogurl/wp-admin/admin.php?page=menutester.php ).

 (3) You will see the correct screen (which says Menu Tester Tab 1), but
 the menu system will show that you are on Options / Menu Tester instead of
 Menu Tester / Menu Tester. And there is no way to click on the other sub-
 menus of your main menu section.

 Here is why this is happening (hope this makes sense -- have to read the
 code!)

 Basically, when the plugin first calls add_options_page to add the Options
 submenu, the add_submenu_page function adds a new item to the global $menu
 array, and then ends up calling get_plugin_page_hookname, which calls
 get_admin_page_parent() (adll these functions are currently located in wp-
 admin/includes/plugin.php as of [6124]).

 At this point, the global $pagenow variable is set to 'admin.php', and the
 $plugin_page variable is set to 'menutester.php'.

 So, the get_admin_page_parent function goes through the $menu array, and
 searches for a menu item whose plugin file is set to 'menutester.php'. It
 finds the newly-added options page, and sets the global $parent_file
 variable to the parent file, i.e. options-general.php.

 The issue is that subsequent calls to get_admin_page_parent use the pre-
 set global variable value of $parent_file, rather than searching through
 $menu again. So when the menu system calls get_admin_page_parent to figure
 out what the current page is, it thinks the current page is options-
 general.php's Menu Tester page.  Which is not correct.

 Resetting $parent_file to an empty string right before calling
 get_admin_page_parent in the menu system fixes the problem -- the function
 then finds the correct menu items to highlight. I'll attach a patch.

-- 
Ticket URL: <http://trac.wordpress.org/ticket/5001>
WordPress Trac <http://trac.wordpress.org/>
WordPress blogging software