wp-admin/menu.php

   1 <?php
   2 /**
   3  * Build Administration Menu.
   4  *
   5  * @package WordPress
   6  * @subpackage Administration
   7  */
   8
   9 /**
  10  * Constructs the admin menu bar.
  11  *
  12  * The elements in the array are :
  13  *     0: Menu item name
  14  *     1: Minimum level or capability required.
  15  *     2: The URL of the item's file
  16  *     3: Class
  17  *     4: ID
  18  *     5: Icon for top level menu
  19  *
  20  * @global array $menu
  21  * @name $menu
  22  * @var array
  23  */
  24
  25 $awaiting_mod = wp_count_comments();
  26 $awaiting_mod = $awaiting_mod->moderated;
  27
  28 if ( is_multisite() && is_super_admin() ) {
  29         /* translators: Network menu item */
  30         $menu[0] = array(__('Super Admin'), 'manage_network', 'ms-admin.php', '', 'menu-top menu-top-first menu-icon-site', 'menu-site', 'div');
  31         $submenu[ 'ms-admin.php' ][1] = array( __('Admin'), 'manage_network', 'ms-admin.php' );
  32         /* translators: Sites menu item */
  33         $submenu[ 'ms-admin.php' ][5] = array( __('Sites'), 'manage_sites', 'ms-sites.php' );
  34         $submenu[ 'ms-admin.php' ][10] = array( __('Users'), 'manage_network_users', 'ms-users.php' );
  35         $submenu[ 'ms-admin.php' ][20] = array( __('Themes'), 'manage_network_themes', 'ms-themes.php' );
  36         $submenu[ 'ms-admin.php' ][25] = array( __('Options'), 'manage_network_options', 'ms-options.php' );
  37         $submenu[ 'ms-admin.php' ][30] = array( __('Update'), 'manage_network', 'ms-upgrade-network.php' );
  38
  39         $menu[1] = array( '', 'read', 'separator1', '', 'wp-menu-separator' );
  40
  41         $menu[2] = array( __('Dashboard'), 'read', 'index.php', '', 'menu-top menu-icon-dashboard', 'menu-dashboard', 'div' );
  42 } else {
  43         $menu[2] = array( __('Dashboard'), 'read', 'index.php', '', 'menu-top menu-top-first menu-icon-dashboard', 'menu-dashboard', 'div' );
  44 }
  45
  46 if ( is_multisite() || is_super_admin() ) {
  47         $submenu[ 'index.php' ][0] = array( __('Dashboard'), 'read', 'index.php' );
  48
  49         if ( is_multisite() )
  50                 $submenu[ 'index.php' ][5] = array( __('My Sites'), 'read', 'my-sites.php' );
  51
  52         if ( is_super_admin() ) {
  53                 $plugin_update_count = $theme_update_count = $wordpress_update_count = 0;
  54                 $update_plugins = get_site_transient( 'update_plugins' );
  55                 if ( !empty($update_plugins->response) )
  56                         $plugin_update_count = count( $update_plugins->response );
  57                 $update_themes = get_site_transient( 'update_themes' );
  58                 if ( !empty($update_themes->response) )
  59                         $theme_update_count = count( $update_themes->response );
  60                 $update_wordpress = get_core_updates( array('dismissed' => false) );
  61                 if ( !empty($update_wordpress) && !in_array( $update_wordpress[0]->response, array('development', 'latest') ) )
  62                         $wordpress_update_count = 1;
  63
  64                 $update_count = $plugin_update_count + $theme_update_count + $wordpress_update_count;
  65                 $update_title = array();
  66                 if ( $wordpress_update_count )
  67                         $update_title[] = sprintf(__('%d WordPress Update'), $wordpress_update_count);
  68                 if ( $plugin_update_count )
  69                         $update_title[] = sprintf(_n('%d Plugin Update', '%d Plugin Updates', $plugin_update_count), $plugin_update_count);
  70                 if ( $theme_update_count )
  71                         $update_title[] = sprintf(_n('%d Theme Update', '%d Themes Updates', $theme_update_count), $theme_update_count);
  72
  73                 $update_title = !empty($update_title) ? esc_attr(implode(', ', $update_title)) : '';
  74
  75                 $submenu[ 'index.php' ][10] = array( sprintf( __('Updates %s'), "<span class='update-plugins count-$update_count' title='$update_title'><span class='update-count'>" . number_format_i18n($update_count) . "</span></span>" ), 'install_plugins',  'update-core.php');
  76                 unset($plugin_update_count, $theme_update_count, $wordpress_update_count, $update_count, $update_title);
  77         }
  78 }
  79
  80 $menu[4] = array( '', 'read', 'separator1', '', 'wp-menu-separator' );
  81
  82 $menu[5] = array( __('Posts'), 'edit_posts', 'edit.php', '', 'open-if-no-js menu-top menu-icon-post', 'menu-posts', 'div' );
  83         $submenu['edit.php'][5]  = array( __('Posts'), 'edit_posts', 'edit.php' );
  84         /* translators: add new post */
  85         $submenu['edit.php'][10]  = array( _x('Add New', 'post'), 'edit_posts', 'post-new.php' );
  86
  87         $i = 15;
  88         foreach ( $wp_taxonomies as $tax ) {
  89                 if ( ! $tax->show_ui || ! in_array('post', (array) $tax->object_type, true) )
  90                         continue;
  91
  92                 $submenu['edit.php'][$i++] = array( esc_attr( $tax->labels->name ), $tax->cap->manage_terms, 'edit-tags.php?taxonomy=' . $tax->name );
  93         }
  94         unset($tax);
  95
  96 $menu[10] = array( __('Media'), 'upload_files', 'upload.php', '', 'menu-top menu-icon-media', 'menu-media', 'div' );
  97         $submenu['upload.php'][5] = array( __('Library'), 'upload_files', 'upload.php');
  98         /* translators: add new file */
  99         $submenu['upload.php'][10] = array( _x('Add New', 'file'), 'upload_files', 'media-new.php');
 100
 101 $menu[15] = array( __('Links'), 'manage_links', 'link-manager.php', '', 'menu-top menu-icon-links', 'menu-links', 'div' );
 102         $submenu['link-manager.php'][5] = array( __('Links'), 'manage_links', 'link-manager.php' );
 103         /* translators: add new links */
 104         $submenu['link-manager.php'][10] = array( _x('Add New', 'link'), 'manage_links', 'link-add.php' );
 105         $submenu['link-manager.php'][15] = array( __('Link Categories'), 'manage_categories', 'edit-link-categories.php' );
 106
 107 $menu[20] = array( __('Pages'), 'edit_pages', 'edit.php?post_type=page', '', 'menu-top menu-icon-page', 'menu-pages', 'div' );
 108         $submenu['edit.php?post_type=page'][5] = array( __('Pages'), 'edit_pages', 'edit.php?post_type=page' );
 109         /* translators: add new page */
 110         $submenu['edit.php?post_type=page'][10] = array( _x('Add New', 'page'), 'edit_pages', 'post-new.php?post_type=page' );
 111         $i = 15;
 112         foreach ( $wp_taxonomies as $tax ) {
 113                 if ( ! $tax->show_ui || ! in_array('page', (array) $tax->object_type, true) )
 114                         continue;
 115
 116                 $submenu['edit.php?post_type=page'][$i++] = array( esc_attr( $tax->labels->name ), $tax->cap->manage_terms, 'edit-tags.php?post_type=page&taxonomy=' . $tax->name );
 117         }
 118         unset($tax);
 119
 120 $menu[25] = array( sprintf( __('Comments %s'), "<span id='awaiting-mod' class='count-$awaiting_mod'><span class='pending-count'>" . number_format_i18n($awaiting_mod) . "</span></span>" ), 'edit_posts', 'edit-comments.php', '', 'menu-top menu-icon-comments', 'menu-comments', 'div' );
 121
 122 $_wp_last_object_menu = 25; // The index of the last top-level menu in the object menu group
 123
 124 foreach ( (array) get_post_types( array('show_ui' => true, '_builtin' => false) ) as $ptype ) {
 125         $ptype_obj = get_post_type_object( $ptype );
 126         $ptype_menu_position = is_int( $ptype_obj->menu_position ) ? $ptype_obj->menu_position : $_wp_last_object_menu++; // If we're to use $_wp_last_object_menu, increment it first.
 127         $ptype_for_id = sanitize_html_class( $ptype );
 128         if ( is_string( $ptype_obj->menu_icon ) ) {
 129                 $menu_icon   = esc_url( $ptype_obj->menu_icon );
 130                 $ptype_class = $ptype_for_id;
 131         } else {
 132                 $menu_icon   = 'div';
 133                 $ptype_class = 'post';
 134         }
 135
 136         // if $ptype_menu_position is already populated or will be populated by a hard-coded value below, increment the position.
 137         $core_menu_positions = array(59, 60, 65, 70, 75, 80, 85, 99);
 138         while ( isset($menu[$ptype_menu_position]) || in_array($ptype_menu_position, $core_menu_positions) )
 139                 $ptype_menu_position++;
 140
 141         $menu[$ptype_menu_position] = array( esc_attr( $ptype_obj->labels->name ), $ptype_obj->cap->edit_posts, "edit.php?post_type=$ptype", '', 'menu-top menu-icon-' . $ptype_class, 'menu-posts-' . $ptype_for_id, $menu_icon );
 142         $submenu["edit.php?post_type=$ptype"][5]  = array( $ptype_obj->labels->name, $ptype_obj->cap->edit_posts,  "edit.php?post_type=$ptype");
 143         $submenu["edit.php?post_type=$ptype"][10]  = array( $ptype_obj->labels->add_new, $ptype_obj->cap->edit_posts, "post-new.php?post_type=$ptype" );
 144
 145         $i = 15;
 146         foreach ( $wp_taxonomies as $tax ) {
 147                 if ( ! $tax->show_ui || ! in_array($ptype, (array) $tax->object_type, true) )
 148                         continue;
 149
 150                 $submenu["edit.php?post_type=$ptype"][$i++] = array( esc_attr( $tax->labels->name ), $tax->cap->manage_terms, "edit-tags.php?taxonomy=$tax->name&amp;post_type=$ptype" );
 151         }
 152 }
 153 unset($ptype, $ptype_obj);
 154
 155 $menu[59] = array( '', 'read', 'separator2', '', 'wp-menu-separator' );
 156
 157 if ( current_user_can( 'switch_themes') ) {
 158         $menu[60] = array( __('Appearance'), 'switch_themes', 'themes.php', '', 'menu-top menu-icon-appearance', 'menu-appearance', 'div' );
 159                 $submenu['themes.php'][5]  = array(__('Themes'), 'switch_themes', 'themes.php');
 160                 if ( current_theme_supports( 'menus' ) || current_theme_supports( 'widgets' ) )
 161                         $submenu['themes.php'][10] = array(__('Menus'), 'edit_theme_options', 'nav-menus.php');
 162 } else {
 163         $menu[60] = array( __('Appearance'), 'edit_theme_options', 'themes.php', '', 'menu-top menu-icon-appearance', 'menu-appearance', 'div' );
 164                 $submenu['themes.php'][5]  = array(__('Themes'), 'edit_theme_options', 'themes.php');
 165                 if ( current_theme_supports( 'menus' ) || current_theme_supports( 'widgets' ) )
 166                         $submenu['themes.php'][10] = array(__('Menus'), 'edit_theme_options', 'nav-menus.php' );
 167 }
 168
 169 // Add 'Editor' to the bottom of the Appearence menu.
 170 add_action('admin_menu', '_add_themes_utility_last', 101);
 171 function _add_themes_utility_last() {
 172         // Must use API on the admin_menu hook, direct modification is only possible on/before the _admin_menu hook
 173         add_submenu_page('themes.php', _x('Editor', 'theme editor'), _x('Editor', 'theme editor'), 'edit_themes', 'theme-editor.php');
 174 }
 175
 176 $update_plugins = get_site_transient( 'update_plugins' );
 177 $update_count = 0;
 178 if ( !empty($update_plugins->response) )
 179         $update_count = count( $update_plugins->response );
 180
 181 $menu_perms = get_site_option('menu_items', array());
 182 if ( is_super_admin() || ( is_multisite() && isset($menu_perms['plugins']) && $menu_perms['plugins'] ) ) {
 183         $menu[65] = array( sprintf( __('Plugins %s'), "<span class='update-plugins count-$update_count'><span class='plugin-count'>" . number_format_i18n($update_count) . "</span></span>" ), 'activate_plugins', 'plugins.php', '', 'menu-top menu-icon-plugins', 'menu-plugins', 'div' );
 184                 $submenu['plugins.php'][5]  = array( __('Plugins'), 'activate_plugins', 'plugins.php' );
 185                 /* translators: add new plugin */
 186                 $submenu['plugins.php'][10] = array(_x('Add New', 'plugin'), 'install_plugins', 'plugin-install.php');
 187                 $submenu['plugins.php'][15] = array( _x('Editor', 'plugin editor'), 'edit_plugins', 'plugin-editor.php' );
 188 }
 189 unset($menu_perms, $update_plugins, $update_count);
 190
 191 if ( current_user_can('list_users') )
 192         $menu[70] = array( __('Users'), 'list_users', 'users.php', '', 'menu-top menu-icon-users', 'menu-users', 'div' );
 193 else
 194         $menu[70] = array( __('Profile'), 'read', 'profile.php', '', 'menu-top menu-icon-users', 'menu-users', 'div' );
 195
 196 if ( current_user_can('list_users') ) {
 197         $_wp_real_parent_file['profile.php'] = 'users.php'; // Back-compat for plugins adding submenus to profile.php.
 198         $submenu['users.php'][5] = array(__('Users'), 'list_users', 'users.php');
 199         $submenu['users.php'][10] = array(_x('Add New', 'user'), 'create_users', 'user-new.php');
 200
 201         $submenu['users.php'][15] = array(__('Your Profile'), 'read', 'profile.php');
 202 } else {
 203         $_wp_real_parent_file['users.php'] = 'profile.php';
 204         $submenu['profile.php'][5] = array(__('Your Profile'), 'read', 'profile.php');
 205         $submenu['profile.php'][10] = array(__('Add New User'), 'create_users', 'user-new.php');
 206 }
 207
 208 $menu[75] = array( __('Tools'), 'edit_posts', 'tools.php', '', 'menu-top menu-icon-tools', 'menu-tools', 'div' );
 209         $submenu['tools.php'][5] = array( __('Tools'), 'edit_posts', 'tools.php' );
 210         $submenu['tools.php'][10] = array( __('Import'), 'import', 'import.php' );
 211         $submenu['tools.php'][15] = array( __('Export'), 'import', 'export.php' );
 212         if ( is_multisite() && !is_main_site() )
 213                 $submenu['tools.php'][25] = array( __('Delete Site'), 'manage_options', 'ms-delete-site.php' );
 214         if ( ( ! is_multisite() || defined( 'MULTISITE' ) ) && defined('WP_ALLOW_MULTISITE') && WP_ALLOW_MULTISITE && is_super_admin() )
 215                 $submenu['tools.php'][50] = array(__('Network'), 'manage_options', 'network.php');
 216
 217 $menu[80] = array( __('Settings'), 'manage_options', 'options-general.php', '', 'menu-top menu-icon-settings', 'menu-settings', 'div' );
 218         $submenu['options-general.php'][10] = array(_x('General', 'settings screen'), 'manage_options', 'options-general.php');
 219         $submenu['options-general.php'][15] = array(__('Writing'), 'manage_options', 'options-writing.php');
 220         $submenu['options-general.php'][20] = array(__('Reading'), 'manage_options', 'options-reading.php');
 221         $submenu['options-general.php'][25] = array(__('Discussion'), 'manage_options', 'options-discussion.php');
 222         $submenu['options-general.php'][30] = array(__('Media'), 'manage_options', 'options-media.php');
 223         $submenu['options-general.php'][35] = array(__('Privacy'), 'manage_options', 'options-privacy.php');
 224         $submenu['options-general.php'][40] = array(__('Permalinks'), 'manage_options', 'options-permalink.php');
 225
 226 $_wp_last_utility_menu = 80; // The index of the last top-level menu in the utility menu group
 227
 228 $menu[99] = array( '', 'read', 'separator-last', '', 'wp-menu-separator-last' );
 229
 230 // Back-compat for old top-levels
 231 $_wp_real_parent_file['post.php'] = 'edit.php';
 232 $_wp_real_parent_file['post-new.php'] = 'edit.php';
 233 $_wp_real_parent_file['edit-pages.php'] = 'edit.php?post_type=page';
 234 $_wp_real_parent_file['page-new.php'] = 'edit.php?post_type=page';
 235 $_wp_real_parent_file['wpmu-admin.php'] = 'ms-admin.php';
 236
 237 do_action('_admin_menu');
 238
 239 // Create list of page plugin hook names.
 240 foreach ($menu as $menu_page) {
 241         if ( false !== $pos = strpos($menu_page[2], '?') ) {
 242                 // Handle post_type=post|page|foo pages.
 243                 $hook_name = substr($menu_page[2], 0, $pos);
 244                 $hook_args = substr($menu_page[2], $pos + 1);
 245                 wp_parse_str($hook_args, $hook_args);
 246                 // Set the hook name to be the post type.
 247                 if ( isset($hook_args['post_type']) )
 248                         $hook_name = $hook_args['post_type'];
 249                 else
 250                         $hook_name = basename($hook_name, '.php');
 251                 unset($hook_args);
 252         } else {
 253                 $hook_name = basename($menu_page[2], '.php');
 254         }
 255         $hook_name = sanitize_title($hook_name);
 256
 257         // ensure we're backwards compatible
 258         $compat = array(
 259                 'index' => 'dashboard',
 260                 'edit' => 'posts',
 261                 'post' => 'posts',
 262                 'upload' => 'media',
 263                 'link-manager' => 'links',
 264                 'edit-pages' => 'pages',
 265                 'page' => 'pages',
 266                 'edit-comments' => 'comments',
 267                 'options-general' => 'settings',
 268                 'themes' => 'appearance',
 269                 );
 270
 271         if ( isset($compat[$hook_name]) )
 272                 $hook_name = $compat[$hook_name];
 273         elseif ( !$hook_name )
 274                 continue;
 275
 276         $admin_page_hooks[$menu_page[2]] = $hook_name;
 277 }
 278 unset($menu_page);
 279
 280 $_wp_submenu_nopriv = array();
 281 $_wp_menu_nopriv = array();
 282 // Loop over submenus and remove pages for which the user does not have privs.
 283 foreach ( array( 'submenu' ) as $sub_loop ) {
 284         foreach ($$sub_loop as $parent => $sub) {
 285                 foreach ($sub as $index => $data) {
 286                         if ( ! current_user_can($data[1]) ) {
 287                                 unset(${$sub_loop}[$parent][$index]);
 288                                 $_wp_submenu_nopriv[$parent][$data[2]] = true;
 289                         }
 290                 }
 291                 unset($index, $data);
 292
 293                 if ( empty(${$sub_loop}[$parent]) )
 294                         unset(${$sub_loop}[$parent]);
 295         }
 296         unset($sub, $parent);
 297 }
 298 unset($sub_loop);
 299
 300 // Loop over the top-level menu.
 301 // Menus for which the original parent is not accessible due to lack of privs will have the next
 302 // submenu in line be assigned as the new menu parent.
 303 foreach ( $menu as $id => $data ) {
 304         if ( empty($submenu[$data[2]]) )
 305                 continue;
 306         $subs = $submenu[$data[2]];
 307         $first_sub = array_shift($subs);
 308         $old_parent = $data[2];
 309         $new_parent = $first_sub[2];
 310         // If the first submenu is not the same as the assigned parent,
 311         // make the first submenu the new parent.
 312         if ( $new_parent != $old_parent ) {
 313                 $_wp_real_parent_file[$old_parent] = $new_parent;
 314                 $menu[$id][2] = $new_parent;
 315
 316                 foreach ($submenu[$old_parent] as $index => $data) {
 317                         $submenu[$new_parent][$index] = $submenu[$old_parent][$index];
 318                         unset($submenu[$old_parent][$index]);
 319                 }
 320                 unset($submenu[$old_parent], $index);
 321
 322                 if ( isset($_wp_submenu_nopriv[$old_parent]) )
 323                         $_wp_submenu_nopriv[$new_parent] = $_wp_submenu_nopriv[$old_parent];
 324         }
 325 }
 326 unset($id, $data, $subs, $first_sub, $old_parent, $new_parent);
 327
 328 do_action('admin_menu', '');
 329
 330 // Remove menus that have no accessible submenus and require privs that the user does not have.
 331 // Run re-parent loop again.
 332 foreach ( $menu as $id => $data ) {
 333         if ( ! current_user_can($data[1]) )
 334                 $_wp_menu_nopriv[$data[2]] = true;
 335
 336         // If submenu is empty...
 337         if ( empty($submenu[$data[2]]) ) {
 338                 // And user doesn't have privs, remove menu.
 339                 if ( isset( $_wp_menu_nopriv[$data[2]] ) ) {
 340                         unset($menu[$id]);
 341                 }
 342         }
 343 }
 344 unset($id, $data);
 345
 346 // Remove any duplicated seperators
 347 $seperator_found = false;
 348 foreach ( $menu as $id => $data ) {
 349         if ( 0 == strcmp('wp-menu-separator', $data[4] ) ) {
 350                 if (false == $seperator_found) {
 351                         $seperator_found = true;
 352                 } else {
 353                         unset($menu[$id]);
 354                         $seperator_found = false;
 355                 }
 356         } else {
 357                 $seperator_found = false;
 358         }
 359 }
 360 unset($id, $data);
 361
 362 function add_cssclass($add, $class) {
 363         $class = empty($class) ? $add : $class .= ' ' . $add;
 364         return $class;
 365 }
 366
 367 function add_menu_classes($menu) {
 368
 369         $first = $lastorder = false;
 370         $i = 0;
 371         $mc = count($menu);
 372         foreach ( $menu as $order => $top ) {
 373                 $i++;
 374
 375                 if ( 0 == $order ) { // dashboard is always shown/single
 376                         $menu[0][4] = add_cssclass('menu-top-first', $top[4]);
 377                         $lastorder = 0;
 378                         continue;
 379                 }
 380
 381                 if ( 0 === strpos($top[2], 'separator') ) { // if separator
 382                         $first = true;
 383                         $c = $menu[$lastorder][4];
 384                         $menu[$lastorder][4] = add_cssclass('menu-top-last', $c);
 385                         continue;
 386                 }
 387
 388                 if ( $first ) {
 389                         $c = $menu[$order][4];
 390                         $menu[$order][4] = add_cssclass('menu-top-first', $c);
 391                         $first = false;
 392                 }
 393
 394                 if ( $mc == $i ) { // last item
 395                         $c = $menu[$order][4];
 396                         $menu[$order][4] = add_cssclass('menu-top-last', $c);
 397                 }
 398
 399                 $lastorder = $order;
 400         }
 401
 402         return apply_filters( 'add_menu_classes', $menu );
 403 }
 404
 405 uksort($menu, "strnatcasecmp"); // make it all pretty
 406
 407 if ( apply_filters('custom_menu_order', false) ) {
 408         $menu_order = array();
 409         foreach ( $menu as $menu_item ) {
 410                 $menu_order[] = $menu_item[2];
 411         }
 412         unset($menu_item);
 413         $default_menu_order = $menu_order;
 414         $menu_order = apply_filters('menu_order', $menu_order);
 415         $menu_order = array_flip($menu_order);
 416         $default_menu_order = array_flip($default_menu_order);
 417
 418         function sort_menu($a, $b) {
 419                 global $menu_order, $default_menu_order;
 420                 $a = $a[2];
 421                 $b = $b[2];
 422                 if ( isset($menu_order[$a]) && !isset($menu_order[$b]) ) {
 423                         return -1;
 424                 } elseif ( !isset($menu_order[$a]) && isset($menu_order[$b]) ) {
 425                         return 1;
 426                 } elseif ( isset($menu_order[$a]) && isset($menu_order[$b]) ) {
 427                         if ( $menu_order[$a] == $menu_order[$b] )
 428                                 return 0;
 429                         return ($menu_order[$a] < $menu_order[$b]) ? -1 : 1;
 430                 } else {
 431                         return ($default_menu_order[$a] <= $default_menu_order[$b]) ? -1 : 1;
 432                 }
 433         }
 434
 435         usort($menu, 'sort_menu');
 436         unset($menu_order, $default_menu_order);
 437 }
 438
 439 $menu = add_menu_classes($menu);
 440
 441 if ( !user_can_access_admin_page() ) {
 442         do_action('admin_page_access_denied');
 443         wp_die( __('You do not have sufficient permissions to access this page.') );
 444 }
 445
 446 ?>