3 * Build Administration Menu.
6 * @subpackage Administration
9 if ( is_network_admin() ) {
12 * Fires before the administration menu loads in the Network Admin.
14 * The hook fires before menus and sub-menus are removed based on user privileges.
19 do_action( '_network_admin_menu' );
20 } elseif ( is_user_admin() ) {
23 * Fires before the administration menu loads in the User Admin.
25 * The hook fires before menus and sub-menus are removed based on user privileges.
30 do_action( '_user_admin_menu' );
34 * Fires before the administration menu loads in the admin.
36 * The hook fires before menus and sub-menus are removed based on user privileges.
41 do_action( '_admin_menu' );
44 // Create list of page plugin hook names.
45 foreach ($menu as $menu_page) {
46 if ( false !== $pos = strpos($menu_page[2], '?') ) {
47 // Handle post_type=post|page|foo pages.
48 $hook_name = substr($menu_page[2], 0, $pos);
49 $hook_args = substr($menu_page[2], $pos + 1);
50 wp_parse_str($hook_args, $hook_args);
51 // Set the hook name to be the post type.
52 if ( isset($hook_args['post_type']) )
53 $hook_name = $hook_args['post_type'];
55 $hook_name = basename($hook_name, '.php');
58 $hook_name = basename($menu_page[2], '.php');
60 $hook_name = sanitize_title($hook_name);
62 if ( isset($compat[$hook_name]) )
63 $hook_name = $compat[$hook_name];
64 elseif ( !$hook_name )
67 $admin_page_hooks[$menu_page[2]] = $hook_name;
69 unset($menu_page, $compat);
71 $_wp_submenu_nopriv = array();
72 $_wp_menu_nopriv = array();
73 // Loop over submenus and remove pages for which the user does not have privs.
74 foreach ( array( 'submenu' ) as $sub_loop ) {
75 foreach ($$sub_loop as $parent => $sub) {
76 foreach ($sub as $index => $data) {
77 if ( ! current_user_can($data[1]) ) {
78 unset(${$sub_loop}[$parent][$index]);
79 $_wp_submenu_nopriv[$parent][$data[2]] = true;
84 if ( empty(${$sub_loop}[$parent]) )
85 unset(${$sub_loop}[$parent]);
92 * Loop over the top-level menu.
93 * Menus for which the original parent is not accessible due to lack of privileges
94 * will have the next submenu in line be assigned as the new menu parent.
96 foreach ( $menu as $id => $data ) {
97 if ( empty($submenu[$data[2]]) )
99 $subs = $submenu[$data[2]];
100 $first_sub = array_shift($subs);
101 $old_parent = $data[2];
102 $new_parent = $first_sub[2];
103 // If the first submenu is not the same as the assigned parent,
104 // make the first submenu the new parent.
105 if ( $new_parent != $old_parent ) {
106 $_wp_real_parent_file[$old_parent] = $new_parent;
107 $menu[$id][2] = $new_parent;
109 foreach ($submenu[$old_parent] as $index => $data) {
110 $submenu[$new_parent][$index] = $submenu[$old_parent][$index];
111 unset($submenu[$old_parent][$index]);
113 unset($submenu[$old_parent], $index);
115 if ( isset($_wp_submenu_nopriv[$old_parent]) )
116 $_wp_submenu_nopriv[$new_parent] = $_wp_submenu_nopriv[$old_parent];
119 unset($id, $data, $subs, $first_sub, $old_parent, $new_parent);
121 if ( is_network_admin() ) {
124 * Fires before the administration menu loads in the Network Admin.
128 * @param string $context Empty context.
130 do_action( 'network_admin_menu', '' );
131 } elseif ( is_user_admin() ) {
134 * Fires before the administration menu loads in the User Admin.
138 * @param string $context Empty context.
140 do_action( 'user_admin_menu', '' );
144 * Fires before the administration menu loads in the admin.
148 * @param string $context Empty context.
150 do_action( 'admin_menu', '' );
154 * Remove menus that have no accessible submenus and require privileges
155 * that the user does not have. Run re-parent loop again.
157 foreach ( $menu as $id => $data ) {
158 if ( ! current_user_can($data[1]) )
159 $_wp_menu_nopriv[$data[2]] = true;
162 * If there is only one submenu and it is has same destination as the parent,
163 * remove the submenu.
165 if ( ! empty( $submenu[$data[2]] ) && 1 == count ( $submenu[$data[2]] ) ) {
166 $subs = $submenu[$data[2]];
167 $first_sub = array_shift($subs);
168 if ( $data[2] == $first_sub[2] )
169 unset( $submenu[$data[2]] );
172 // If submenu is empty...
173 if ( empty($submenu[$data[2]]) ) {
174 // And user doesn't have privs, remove menu.
175 if ( isset( $_wp_menu_nopriv[$data[2]] ) ) {
180 unset($id, $data, $subs, $first_sub);
182 // Remove any duplicated separators
183 $separator_found = false;
184 foreach ( $menu as $id => $data ) {
185 if ( 0 == strcmp('wp-menu-separator', $data[4] ) ) {
186 if (false == $separator_found) {
187 $separator_found = true;
190 $separator_found = false;
193 $separator_found = false;
198 function add_cssclass($add, $class) {
199 $class = empty($class) ? $add : $class .= ' ' . $add;
203 function add_menu_classes($menu) {
205 $first = $lastorder = false;
208 foreach ( $menu as $order => $top ) {
211 if ( 0 == $order ) { // dashboard is always shown/single
212 $menu[0][4] = add_cssclass('menu-top-first', $top[4]);
217 if ( 0 === strpos($top[2], 'separator') && false !== $lastorder ) { // if separator
219 $c = $menu[$lastorder][4];
220 $menu[$lastorder][4] = add_cssclass('menu-top-last', $c);
225 $c = $menu[$order][4];
226 $menu[$order][4] = add_cssclass('menu-top-first', $c);
230 if ( $mc == $i ) { // last item
231 $c = $menu[$order][4];
232 $menu[$order][4] = add_cssclass('menu-top-last', $c);
239 * Filter administration menus array with classes added for top-level items.
243 * @param array $menu Associative array of administration menu items.
245 return apply_filters( 'add_menu_classes', $menu );
248 uksort($menu, "strnatcasecmp"); // make it all pretty
251 * Filter whether to enable custom ordering of the administration menu.
253 * See the 'menu_order' filter for reordering menu items.
257 * @param bool $custom Whether custom ordering is enabled. Default false.
259 if ( apply_filters( 'custom_menu_order', false ) ) {
260 $menu_order = array();
261 foreach ( $menu as $menu_item ) {
262 $menu_order[] = $menu_item[2];
265 $default_menu_order = $menu_order;
268 * Filter the order of administration menu items.
270 * A truthy value must first be passed to the 'custom_menu_order' filter
271 * for this filter to work. Use the following to enable custom menu ordering:
273 * add_filter( 'custom_menu_order', '__return_true' );
277 * @param array $menu_order An ordered array of menu items.
279 $menu_order = apply_filters( 'menu_order', $menu_order );
280 $menu_order = array_flip($menu_order);
281 $default_menu_order = array_flip($default_menu_order);
283 function sort_menu($a, $b) {
284 global $menu_order, $default_menu_order;
287 if ( isset($menu_order[$a]) && !isset($menu_order[$b]) ) {
289 } elseif ( !isset($menu_order[$a]) && isset($menu_order[$b]) ) {
291 } elseif ( isset($menu_order[$a]) && isset($menu_order[$b]) ) {
292 if ( $menu_order[$a] == $menu_order[$b] )
294 return ($menu_order[$a] < $menu_order[$b]) ? -1 : 1;
296 return ($default_menu_order[$a] <= $default_menu_order[$b]) ? -1 : 1;
300 usort($menu, 'sort_menu');
301 unset($menu_order, $default_menu_order);
304 // Remove the last menu item if it is a separator.
305 $last_menu_key = array_keys( $menu );
306 $last_menu_key = array_pop( $last_menu_key );
307 if ( !empty( $menu ) && 'wp-menu-separator' == $menu[ $last_menu_key ][ 4 ] )
308 unset( $menu[ $last_menu_key ] );
309 unset( $last_menu_key );
311 if ( !user_can_access_admin_page() ) {
314 * Fires when access to an admin page is denied.
318 do_action( 'admin_page_access_denied' );
320 wp_die( __('You do not have sufficient permissions to access this page.') );
323 $menu = add_menu_classes($menu);