/wp-admin/includes/menu.php

  1. <?php 
  2. /** 
  3. * Build Administration Menu. 
  4. * 
  5. * @package WordPress 
  6. * @subpackage Administration 
  7. */ 
  8.  
  9. if ( is_network_admin() ) { 
  10.  
  11. /** 
  12. * Fires before the administration menu loads in the Network Admin. 
  13. * 
  14. * The hook fires before menus and sub-menus are removed based on user privileges. 
  15. * 
  16. * @private 
  17. * @since 3.1.0 
  18. */ 
  19. do_action( '_network_admin_menu' ); 
  20. } elseif ( is_user_admin() ) { 
  21.  
  22. /** 
  23. * Fires before the administration menu loads in the User Admin. 
  24. * 
  25. * The hook fires before menus and sub-menus are removed based on user privileges. 
  26. * 
  27. * @private 
  28. * @since 3.1.0 
  29. */ 
  30. do_action( '_user_admin_menu' ); 
  31. } else { 
  32.  
  33. /** 
  34. * Fires before the administration menu loads in the admin. 
  35. * 
  36. * The hook fires before menus and sub-menus are removed based on user privileges. 
  37. * 
  38. * @private 
  39. * @since 2.2.0 
  40. */ 
  41. do_action( '_admin_menu' ); 
  42.  
  43. // Create list of page plugin hook names. 
  44. foreach ($menu as $menu_page) { 
  45. if ( false !== $pos = strpos($menu_page[2], '?') ) { 
  46. // Handle post_type=post|page|foo pages. 
  47. $hook_name = substr($menu_page[2], 0, $pos); 
  48. $hook_args = substr($menu_page[2], $pos + 1); 
  49. wp_parse_str($hook_args, $hook_args); 
  50. // Set the hook name to be the post type. 
  51. if ( isset($hook_args['post_type']) ) 
  52. $hook_name = $hook_args['post_type']; 
  53. else 
  54. $hook_name = basename($hook_name, '.php'); 
  55. unset($hook_args); 
  56. } else { 
  57. $hook_name = basename($menu_page[2], '.php'); 
  58. $hook_name = sanitize_title($hook_name); 
  59.  
  60. if ( isset($compat[$hook_name]) ) 
  61. $hook_name = $compat[$hook_name]; 
  62. elseif ( !$hook_name ) 
  63. continue; 
  64.  
  65. $admin_page_hooks[$menu_page[2]] = $hook_name; 
  66. unset($menu_page, $compat); 
  67.  
  68. $_wp_submenu_nopriv = array(); 
  69. $_wp_menu_nopriv = array(); 
  70. // Loop over submenus and remove pages for which the user does not have privs. 
  71. foreach ($submenu as $parent => $sub) { 
  72. foreach ($sub as $index => $data) { 
  73. if ( ! current_user_can($data[1]) ) { 
  74. unset($submenu[$parent][$index]); 
  75. $_wp_submenu_nopriv[$parent][$data[2]] = true; 
  76. unset($index, $data); 
  77.  
  78. if ( empty($submenu[$parent]) ) 
  79. unset($submenu[$parent]); 
  80. unset($sub, $parent); 
  81.  
  82. /** 
  83. * Loop over the top-level menu. 
  84. * Menus for which the original parent is not accessible due to lack of privileges 
  85. * will have the next submenu in line be assigned as the new menu parent. 
  86. */ 
  87. foreach ( $menu as $id => $data ) { 
  88. if ( empty($submenu[$data[2]]) ) 
  89. continue; 
  90. $subs = $submenu[$data[2]]; 
  91. $first_sub = reset( $subs ); 
  92. $old_parent = $data[2]; 
  93. $new_parent = $first_sub[2]; 
  94. /** 
  95. * If the first submenu is not the same as the assigned parent,  
  96. * make the first submenu the new parent. 
  97. */ 
  98. if ( $new_parent != $old_parent ) { 
  99. $_wp_real_parent_file[$old_parent] = $new_parent; 
  100. $menu[$id][2] = $new_parent; 
  101.  
  102. foreach ($submenu[$old_parent] as $index => $data) { 
  103. $submenu[$new_parent][$index] = $submenu[$old_parent][$index]; 
  104. unset($submenu[$old_parent][$index]); 
  105. unset($submenu[$old_parent], $index); 
  106.  
  107. if ( isset($_wp_submenu_nopriv[$old_parent]) ) 
  108. $_wp_submenu_nopriv[$new_parent] = $_wp_submenu_nopriv[$old_parent]; 
  109. unset($id, $data, $subs, $first_sub, $old_parent, $new_parent); 
  110.  
  111. if ( is_network_admin() ) { 
  112.  
  113. /** 
  114. * Fires before the administration menu loads in the Network Admin. 
  115. * 
  116. * @since 3.1.0 
  117. * 
  118. * @param string $context Empty context. 
  119. */ 
  120. do_action( 'network_admin_menu', '' ); 
  121. } elseif ( is_user_admin() ) { 
  122.  
  123. /** 
  124. * Fires before the administration menu loads in the User Admin. 
  125. * 
  126. * @since 3.1.0 
  127. * 
  128. * @param string $context Empty context. 
  129. */ 
  130. do_action( 'user_admin_menu', '' ); 
  131. } else { 
  132.  
  133. /** 
  134. * Fires before the administration menu loads in the admin. 
  135. * 
  136. * @since 1.5.0 
  137. * 
  138. * @param string $context Empty context. 
  139. */ 
  140. do_action( 'admin_menu', '' ); 
  141.  
  142. /** 
  143. * Remove menus that have no accessible submenus and require privileges 
  144. * that the user does not have. Run re-parent loop again. 
  145. */ 
  146. foreach ( $menu as $id => $data ) { 
  147. if ( ! current_user_can($data[1]) ) 
  148. $_wp_menu_nopriv[$data[2]] = true; 
  149.  
  150. /** 
  151. * If there is only one submenu and it is has same destination as the parent,  
  152. * remove the submenu. 
  153. */ 
  154. if ( ! empty( $submenu[$data[2]] ) && 1 == count ( $submenu[$data[2]] ) ) { 
  155. $subs = $submenu[$data[2]]; 
  156. $first_sub = reset( $subs ); 
  157. if ( $data[2] == $first_sub[2] ) 
  158. unset( $submenu[$data[2]] ); 
  159.  
  160. // If submenu is empty... 
  161. if ( empty($submenu[$data[2]]) ) { 
  162. // And user doesn't have privs, remove menu. 
  163. if ( isset( $_wp_menu_nopriv[$data[2]] ) ) { 
  164. unset($menu[$id]); 
  165. unset($id, $data, $subs, $first_sub); 
  166.  
  167. /** 
  168. * 
  169. * @param string $add 
  170. * @param string $class 
  171. * @return string 
  172. */ 
  173. function add_cssclass($add, $class) { 
  174. $class = empty($class) ? $add : $class .= ' ' . $add; 
  175. return $class; 
  176.  
  177. /** 
  178. * 
  179. * @param array $menu 
  180. * @return array 
  181. */ 
  182. function add_menu_classes($menu) { 
  183. $first = $lastorder = false; 
  184. $i = 0; 
  185. $mc = count($menu); 
  186. foreach ( $menu as $order => $top ) { 
  187. $i++; 
  188.  
  189. if ( 0 == $order ) { // dashboard is always shown/single 
  190. $menu[0][4] = add_cssclass('menu-top-first', $top[4]); 
  191. $lastorder = 0; 
  192. continue; 
  193.  
  194. if ( 0 === strpos($top[2], 'separator') && false !== $lastorder ) { // if separator 
  195. $first = true; 
  196. $c = $menu[$lastorder][4]; 
  197. $menu[$lastorder][4] = add_cssclass('menu-top-last', $c); 
  198. continue; 
  199.  
  200. if ( $first ) { 
  201. $c = $menu[$order][4]; 
  202. $menu[$order][4] = add_cssclass('menu-top-first', $c); 
  203. $first = false; 
  204.  
  205. if ( $mc == $i ) { // last item 
  206. $c = $menu[$order][4]; 
  207. $menu[$order][4] = add_cssclass('menu-top-last', $c); 
  208.  
  209. $lastorder = $order; 
  210.  
  211. /** 
  212. * Filters administration menus array with classes added for top-level items. 
  213. * 
  214. * @since 2.7.0 
  215. * 
  216. * @param array $menu Associative array of administration menu items. 
  217. */ 
  218. return apply_filters( 'add_menu_classes', $menu ); 
  219.  
  220. uksort($menu, "strnatcasecmp"); // make it all pretty 
  221.  
  222. /** 
  223. * Filters whether to enable custom ordering of the administration menu. 
  224. * 
  225. * See the {@see 'menu_order'} filter for reordering menu items. 
  226. * 
  227. * @since 2.8.0 
  228. * 
  229. * @param bool $custom Whether custom ordering is enabled. Default false. 
  230. */ 
  231. if ( apply_filters( 'custom_menu_order', false ) ) { 
  232. $menu_order = array(); 
  233. foreach ( $menu as $menu_item ) { 
  234. $menu_order[] = $menu_item[2]; 
  235. unset($menu_item); 
  236. $default_menu_order = $menu_order; 
  237.  
  238. /** 
  239. * Filters the order of administration menu items. 
  240. * 
  241. * A truthy value must first be passed to the {@see 'custom_menu_order'} filter 
  242. * for this filter to work. Use the following to enable custom menu ordering: 
  243. * 
  244. * add_filter( 'custom_menu_order', '__return_true' ); 
  245. * 
  246. * @since 2.8.0 
  247. * 
  248. * @param array $menu_order An ordered array of menu items. 
  249. */ 
  250. $menu_order = apply_filters( 'menu_order', $menu_order ); 
  251. $menu_order = array_flip($menu_order); 
  252. $default_menu_order = array_flip($default_menu_order); 
  253.  
  254. /** 
  255. * 
  256. * @global array $menu_order 
  257. * @global array $default_menu_order 
  258. * 
  259. * @param array $a 
  260. * @param array $b 
  261. * @return int 
  262. */ 
  263. function sort_menu($a, $b) { 
  264. global $menu_order, $default_menu_order; 
  265. $a = $a[2]; 
  266. $b = $b[2]; 
  267. if ( isset($menu_order[$a]) && !isset($menu_order[$b]) ) { 
  268. return -1; 
  269. } elseif ( !isset($menu_order[$a]) && isset($menu_order[$b]) ) { 
  270. return 1; 
  271. } elseif ( isset($menu_order[$a]) && isset($menu_order[$b]) ) { 
  272. if ( $menu_order[$a] == $menu_order[$b] ) 
  273. return 0; 
  274. return ($menu_order[$a] < $menu_order[$b]) ? -1 : 1; 
  275. } else { 
  276. return ($default_menu_order[$a] <= $default_menu_order[$b]) ? -1 : 1; 
  277.  
  278. usort($menu, 'sort_menu'); 
  279. unset($menu_order, $default_menu_order); 
  280.  
  281. // Prevent adjacent separators 
  282. $prev_menu_was_separator = false; 
  283. foreach ( $menu as $id => $data ) { 
  284. if ( false === stristr( $data[4], 'wp-menu-separator' ) ) { 
  285.  
  286. // This item is not a separator, so falsey the toggler and do nothing 
  287. $prev_menu_was_separator = false; 
  288. } else { 
  289.  
  290. // The previous item was a separator, so unset this one 
  291. if ( true === $prev_menu_was_separator ) { 
  292. unset( $menu[ $id ] ); 
  293.  
  294. // This item is a separator, so truthy the toggler and move on 
  295. $prev_menu_was_separator = true; 
  296. unset( $id, $data, $prev_menu_was_separator ); 
  297.  
  298. // Remove the last menu item if it is a separator. 
  299. $last_menu_key = array_keys( $menu ); 
  300. $last_menu_key = array_pop( $last_menu_key ); 
  301. if ( !empty( $menu ) && 'wp-menu-separator' == $menu[ $last_menu_key ][ 4 ] ) 
  302. unset( $menu[ $last_menu_key ] ); 
  303. unset( $last_menu_key ); 
  304.  
  305. if ( !user_can_access_admin_page() ) { 
  306.  
  307. /** 
  308. * Fires when access to an admin page is denied. 
  309. * 
  310. * @since 2.5.0 
  311. */ 
  312. do_action( 'admin_page_access_denied' ); 
  313.  
  314. wp_die( __( 'Sorry, you are not allowed to access this page.' ), 403 ); 
  315.  
  316. $menu = add_menu_classes($menu); 
.