[ Index ]

PHP Cross Reference of WordPress Trunk (Updated Daily)

title

Body

[close]

/wp-admin/ -> menu.php (source)

   1  <?php
   2  /**
   3   * Build Administration Menu.
   4   *
   5   * @package WordPress
   6   * @subpackage Administration
   7   */
   8  
   9  /**
  10   * Constructs the admin menu.
  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   */
  22  
  23  $menu[2] = array( __( 'Dashboard' ), 'read', 'index.php', '', 'menu-top menu-top-first menu-icon-dashboard', 'menu-dashboard', 'dashicons-dashboard' );
  24  
  25  $submenu['index.php'][0] = array( __( 'Home' ), 'read', 'index.php' );
  26  
  27  if ( is_multisite() ) {
  28      $submenu['index.php'][5] = array( __( 'My Sites' ), 'read', 'my-sites.php' );
  29  }
  30  
  31  if ( ! is_multisite() || current_user_can( 'update_core' ) ) {
  32      $update_data = wp_get_update_data();
  33  }
  34  
  35  if ( ! is_multisite() ) {
  36      if ( current_user_can( 'update_core' ) ) {
  37          $cap = 'update_core';
  38      } elseif ( current_user_can( 'update_plugins' ) ) {
  39          $cap = 'update_plugins';
  40      } elseif ( current_user_can( 'update_themes' ) ) {
  41          $cap = 'update_themes';
  42      } else {
  43          $cap = 'update_languages';
  44      }
  45      $submenu['index.php'][10] = array(
  46          sprintf(
  47              /* translators: %s: Number of pending updates. */
  48              __( 'Updates %s' ),
  49              sprintf(
  50                  '<span class="update-plugins count-%s"><span class="update-count">%s</span></span>',
  51                  $update_data['counts']['total'],
  52                  number_format_i18n( $update_data['counts']['total'] )
  53              )
  54          ),
  55          $cap,
  56          'update-core.php',
  57      );
  58      unset( $cap );
  59  }
  60  
  61  $menu[4] = array( '', 'read', 'separator1', '', 'wp-menu-separator' );
  62  
  63  // $menu[5] = Posts
  64  
  65  $menu[10]                     = array( __( 'Media' ), 'upload_files', 'upload.php', '', 'menu-top menu-icon-media', 'menu-media', 'dashicons-admin-media' );
  66      $submenu['upload.php'][5] = array( __( 'Library' ), 'upload_files', 'upload.php' );
  67      /* translators: Add new file. */
  68      $submenu['upload.php'][10] = array( _x( 'Add New', 'file' ), 'upload_files', 'media-new.php' );
  69      $i                         = 15;
  70  foreach ( get_taxonomies_for_attachments( 'objects' ) as $tax ) {
  71      if ( ! $tax->show_ui || ! $tax->show_in_menu ) {
  72          continue;
  73      }
  74  
  75      $submenu['upload.php'][ $i++ ] = array( esc_attr( $tax->labels->menu_name ), $tax->cap->manage_terms, 'edit-tags.php?taxonomy=' . $tax->name . '&amp;post_type=attachment' );
  76  }
  77      unset( $tax, $i );
  78  
  79  $menu[15]                           = array( __( 'Links' ), 'manage_links', 'link-manager.php', '', 'menu-top menu-icon-links', 'menu-links', 'dashicons-admin-links' );
  80      $submenu['link-manager.php'][5] = array( _x( 'All Links', 'admin menu' ), 'manage_links', 'link-manager.php' );
  81      /* translators: Add new links. */
  82      $submenu['link-manager.php'][10] = array( _x( 'Add New', 'link' ), 'manage_links', 'link-add.php' );
  83      $submenu['link-manager.php'][15] = array( __( 'Link Categories' ), 'manage_categories', 'edit-tags.php?taxonomy=link_category' );
  84  
  85  // $menu[20] = Pages
  86  
  87  // Avoid the comment count query for users who cannot edit_posts.
  88  if ( current_user_can( 'edit_posts' ) ) {
  89      $awaiting_mod      = wp_count_comments();
  90      $awaiting_mod      = $awaiting_mod->moderated;
  91      $awaiting_mod_i18n = number_format_i18n( $awaiting_mod );
  92      /* translators: %s: Number of comments. */
  93      $awaiting_mod_text = sprintf( _n( '%s Comment in moderation', '%s Comments in moderation', $awaiting_mod ), $awaiting_mod_i18n );
  94  
  95      $menu[25] = array(
  96          /* translators: %s: Number of comments. */
  97          sprintf( __( 'Comments %s' ), '<span class="awaiting-mod count-' . absint( $awaiting_mod ) . '"><span class="pending-count" aria-hidden="true">' . $awaiting_mod_i18n . '</span><span class="comments-in-moderation-text screen-reader-text">' . $awaiting_mod_text . '</span></span>' ),
  98          'edit_posts',
  99          'edit-comments.php',
 100          '',
 101          'menu-top menu-icon-comments',
 102          'menu-comments',
 103          'dashicons-admin-comments',
 104      );
 105      unset( $awaiting_mod );
 106  }
 107  
 108  $submenu['edit-comments.php'][0] = array( __( 'All Comments' ), 'edit_posts', 'edit-comments.php' );
 109  
 110  $_wp_last_object_menu = 25; // The index of the last top-level menu in the object menu group
 111  
 112  $types   = (array) get_post_types(
 113      array(
 114          'show_ui'      => true,
 115          '_builtin'     => false,
 116          'show_in_menu' => true,
 117      )
 118  );
 119  $builtin = array( 'post', 'page' );
 120  foreach ( array_merge( $builtin, $types ) as $ptype ) {
 121      $ptype_obj = get_post_type_object( $ptype );
 122      // Check if it should be a submenu.
 123      if ( $ptype_obj->show_in_menu !== true ) {
 124          continue;
 125      }
 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  
 129      $menu_icon = 'dashicons-admin-post';
 130      if ( is_string( $ptype_obj->menu_icon ) ) {
 131          // Special handling for data:image/svg+xml and Dashicons.
 132          if ( 0 === strpos( $ptype_obj->menu_icon, 'data:image/svg+xml;base64,' ) || 0 === strpos( $ptype_obj->menu_icon, 'dashicons-' ) ) {
 133              $menu_icon = $ptype_obj->menu_icon;
 134          } else {
 135              $menu_icon = esc_url( $ptype_obj->menu_icon );
 136          }
 137      } elseif ( in_array( $ptype, $builtin ) ) {
 138          $menu_icon = 'dashicons-admin-' . $ptype;
 139      }
 140  
 141      $menu_class = 'menu-top menu-icon-' . $ptype_for_id;
 142      // 'post' special case
 143      if ( 'post' === $ptype ) {
 144          $menu_class    .= ' open-if-no-js';
 145          $ptype_file     = 'edit.php';
 146          $post_new_file  = 'post-new.php';
 147          $edit_tags_file = 'edit-tags.php?taxonomy=%s';
 148      } else {
 149          $ptype_file     = "edit.php?post_type=$ptype";
 150          $post_new_file  = "post-new.php?post_type=$ptype";
 151          $edit_tags_file = "edit-tags.php?taxonomy=%s&amp;post_type=$ptype";
 152      }
 153  
 154      if ( in_array( $ptype, $builtin ) ) {
 155          $ptype_menu_id = 'menu-' . $ptype_for_id . 's';
 156      } else {
 157          $ptype_menu_id = 'menu-posts-' . $ptype_for_id;
 158      }
 159      /*
 160       * If $ptype_menu_position is already populated or will be populated
 161       * by a hard-coded value below, increment the position.
 162       */
 163      $core_menu_positions = array( 59, 60, 65, 70, 75, 80, 85, 99 );
 164      while ( isset( $menu[ $ptype_menu_position ] ) || in_array( $ptype_menu_position, $core_menu_positions ) ) {
 165          $ptype_menu_position++;
 166      }
 167  
 168      $menu[ $ptype_menu_position ] = array( esc_attr( $ptype_obj->labels->menu_name ), $ptype_obj->cap->edit_posts, $ptype_file, '', $menu_class, $ptype_menu_id, $menu_icon );
 169      $submenu[ $ptype_file ][5]    = array( $ptype_obj->labels->all_items, $ptype_obj->cap->edit_posts, $ptype_file );
 170      $submenu[ $ptype_file ][10]   = array( $ptype_obj->labels->add_new, $ptype_obj->cap->create_posts, $post_new_file );
 171  
 172      $i = 15;
 173      foreach ( get_taxonomies( array(), 'objects' ) as $tax ) {
 174          if ( ! $tax->show_ui || ! $tax->show_in_menu || ! in_array( $ptype, (array) $tax->object_type, true ) ) {
 175              continue;
 176          }
 177  
 178          $submenu[ $ptype_file ][ $i++ ] = array( esc_attr( $tax->labels->menu_name ), $tax->cap->manage_terms, sprintf( $edit_tags_file, $tax->name ) );
 179      }
 180  }
 181  unset( $ptype, $ptype_obj, $ptype_for_id, $ptype_menu_position, $menu_icon, $i, $tax, $post_new_file );
 182  
 183  $menu[59] = array( '', 'read', 'separator2', '', 'wp-menu-separator' );
 184  
 185  $appearance_cap = current_user_can( 'switch_themes' ) ? 'switch_themes' : 'edit_theme_options';
 186  
 187  $menu[60]                     = array( __( 'Appearance' ), $appearance_cap, 'themes.php', '', 'menu-top menu-icon-appearance', 'menu-appearance', 'dashicons-admin-appearance' );
 188      $submenu['themes.php'][5] = array( __( 'Themes' ), $appearance_cap, 'themes.php' );
 189  
 190      $customize_url            = add_query_arg( 'return', urlencode( remove_query_arg( wp_removable_query_args(), wp_unslash( $_SERVER['REQUEST_URI'] ) ) ), 'customize.php' );
 191      $submenu['themes.php'][6] = array( __( 'Customize' ), 'customize', esc_url( $customize_url ), '', 'hide-if-no-customize' );
 192  
 193  if ( current_theme_supports( 'menus' ) || current_theme_supports( 'widgets' ) ) {
 194      $submenu['themes.php'][10] = array( __( 'Menus' ), 'edit_theme_options', 'nav-menus.php' );
 195  }
 196  
 197  if ( current_theme_supports( 'custom-header' ) && current_user_can( 'customize' ) ) {
 198      $customize_header_url      = add_query_arg( array( 'autofocus' => array( 'control' => 'header_image' ) ), $customize_url );
 199      $submenu['themes.php'][15] = array( __( 'Header' ), $appearance_cap, esc_url( $customize_header_url ), '', 'hide-if-no-customize' );
 200  }
 201  
 202  if ( current_theme_supports( 'custom-background' ) && current_user_can( 'customize' ) ) {
 203      $customize_background_url  = add_query_arg( array( 'autofocus' => array( 'control' => 'background_image' ) ), $customize_url );
 204      $submenu['themes.php'][20] = array( __( 'Background' ), $appearance_cap, esc_url( $customize_background_url ), '', 'hide-if-no-customize' );
 205  }
 206  
 207      unset( $customize_url );
 208  
 209  unset( $appearance_cap );
 210  
 211  // Add 'Editor' to the bottom of the Appearance menu.
 212  if ( ! is_multisite() ) {
 213      add_action( 'admin_menu', '_add_themes_utility_last', 101 );
 214  }
 215  /**
 216   * Adds the (theme) 'Editor' link to the bottom of the Appearance menu.
 217   *
 218   * @access private
 219   * @since 3.0.0
 220   */
 221  function _add_themes_utility_last() {
 222      // Must use API on the admin_menu hook, direct modification is only possible on/before the _admin_menu hook
 223      add_submenu_page( 'themes.php', __( 'Theme Editor' ), __( 'Theme Editor' ), 'edit_themes', 'theme-editor.php' );
 224  }
 225  
 226  $count = '';
 227  if ( ! is_multisite() && current_user_can( 'update_plugins' ) ) {
 228      if ( ! isset( $update_data ) ) {
 229          $update_data = wp_get_update_data();
 230      }
 231      $count = sprintf(
 232          '<span class="update-plugins count-%s"><span class="plugin-count">%s</span></span>',
 233          $update_data['counts']['plugins'],
 234          number_format_i18n( $update_data['counts']['plugins'] )
 235      );
 236  }
 237  
 238  /* translators: %s: Number of pending plugin updates. */
 239  $menu[65] = array( sprintf( __( 'Plugins %s' ), $count ), 'activate_plugins', 'plugins.php', '', 'menu-top menu-icon-plugins', 'menu-plugins', 'dashicons-admin-plugins' );
 240  
 241  $submenu['plugins.php'][5] = array( __( 'Installed Plugins' ), 'activate_plugins', 'plugins.php' );
 242  
 243  if ( ! is_multisite() ) {
 244      /* translators: Add new plugin. */
 245      $submenu['plugins.php'][10] = array( _x( 'Add New', 'plugin' ), 'install_plugins', 'plugin-install.php' );
 246      $submenu['plugins.php'][15] = array( __( 'Plugin Editor' ), 'edit_plugins', 'plugin-editor.php' );
 247  }
 248  
 249  unset( $update_data );
 250  
 251  if ( current_user_can( 'list_users' ) ) {
 252      $menu[70] = array( __( 'Users' ), 'list_users', 'users.php', '', 'menu-top menu-icon-users', 'menu-users', 'dashicons-admin-users' );
 253  } else {
 254      $menu[70] = array( __( 'Profile' ), 'read', 'profile.php', '', 'menu-top menu-icon-users', 'menu-users', 'dashicons-admin-users' );
 255  }
 256  
 257  if ( current_user_can( 'list_users' ) ) {
 258      $_wp_real_parent_file['profile.php'] = 'users.php'; // Back-compat for plugins adding submenus to profile.php.
 259      $submenu['users.php'][5]             = array( __( 'All Users' ), 'list_users', 'users.php' );
 260      if ( current_user_can( 'create_users' ) ) {
 261          $submenu['users.php'][10] = array( _x( 'Add New', 'user' ), 'create_users', 'user-new.php' );
 262      } elseif ( is_multisite() ) {
 263          $submenu['users.php'][10] = array( _x( 'Add New', 'user' ), 'promote_users', 'user-new.php' );
 264      }
 265  
 266      $submenu['users.php'][15] = array( __( 'Your Profile' ), 'read', 'profile.php' );
 267  } else {
 268      $_wp_real_parent_file['users.php'] = 'profile.php';
 269      $submenu['profile.php'][5]         = array( __( 'Your Profile' ), 'read', 'profile.php' );
 270      if ( current_user_can( 'create_users' ) ) {
 271          $submenu['profile.php'][10] = array( __( 'Add New User' ), 'create_users', 'user-new.php' );
 272      } elseif ( is_multisite() ) {
 273          $submenu['profile.php'][10] = array( __( 'Add New User' ), 'promote_users', 'user-new.php' );
 274      }
 275  }
 276  
 277  $menu[75]                     = array( __( 'Tools' ), 'edit_posts', 'tools.php', '', 'menu-top menu-icon-tools', 'menu-tools', 'dashicons-admin-tools' );
 278      $submenu['tools.php'][5]  = array( __( 'Available Tools' ), 'edit_posts', 'tools.php' );
 279      $submenu['tools.php'][10] = array( __( 'Import' ), 'import', 'import.php' );
 280      $submenu['tools.php'][15] = array( __( 'Export' ), 'export', 'export.php' );
 281      $submenu['tools.php'][20] = array( __( 'Site Health' ), 'view_site_health_checks', 'site-health.php' );
 282      $submenu['tools.php'][25] = array( __( 'Export Personal Data' ), 'export_others_personal_data', 'export-personal-data.php' );
 283      $submenu['tools.php'][30] = array( __( 'Erase Personal Data' ), 'erase_others_personal_data', 'erase-personal-data.php' );
 284  if ( is_multisite() && ! is_main_site() ) {
 285      $submenu['tools.php'][35] = array( __( 'Delete Site' ), 'delete_site', 'ms-delete-site.php' );
 286  }
 287  if ( ! is_multisite() && defined( 'WP_ALLOW_MULTISITE' ) && WP_ALLOW_MULTISITE ) {
 288      $submenu['tools.php'][50] = array( __( 'Network Setup' ), 'setup_network', 'network.php' );
 289  }
 290  
 291  $menu[80]                               = array( __( 'Settings' ), 'manage_options', 'options-general.php', '', 'menu-top menu-icon-settings', 'menu-settings', 'dashicons-admin-settings' );
 292      $submenu['options-general.php'][10] = array( _x( 'General', 'settings screen' ), 'manage_options', 'options-general.php' );
 293      $submenu['options-general.php'][15] = array( __( 'Writing' ), 'manage_options', 'options-writing.php' );
 294      $submenu['options-general.php'][20] = array( __( 'Reading' ), 'manage_options', 'options-reading.php' );
 295      $submenu['options-general.php'][25] = array( __( 'Discussion' ), 'manage_options', 'options-discussion.php' );
 296      $submenu['options-general.php'][30] = array( __( 'Media' ), 'manage_options', 'options-media.php' );
 297      $submenu['options-general.php'][40] = array( __( 'Permalinks' ), 'manage_options', 'options-permalink.php' );
 298      $submenu['options-general.php'][45] = array( __( 'Privacy' ), 'manage_privacy_options', 'options-privacy.php' );
 299  
 300  $_wp_last_utility_menu = 80; // The index of the last top-level menu in the utility menu group
 301  
 302  $menu[99] = array( '', 'read', 'separator-last', '', 'wp-menu-separator' );
 303  
 304  // Back-compat for old top-levels
 305  $_wp_real_parent_file['post.php']       = 'edit.php';
 306  $_wp_real_parent_file['post-new.php']   = 'edit.php';
 307  $_wp_real_parent_file['edit-pages.php'] = 'edit.php?post_type=page';
 308  $_wp_real_parent_file['page-new.php']   = 'edit.php?post_type=page';
 309  $_wp_real_parent_file['wpmu-admin.php'] = 'tools.php';
 310  $_wp_real_parent_file['ms-admin.php']   = 'tools.php';
 311  
 312  // Ensure backward compatibility.
 313  $compat = array(
 314      'index'           => 'dashboard',
 315      'edit'            => 'posts',
 316      'post'            => 'posts',
 317      'upload'          => 'media',
 318      'link-manager'    => 'links',
 319      'edit-pages'      => 'pages',
 320      'page'            => 'pages',
 321      'edit-comments'   => 'comments',
 322      'options-general' => 'settings',
 323      'themes'          => 'appearance',
 324  );
 325  
 326  require_once ( ABSPATH . 'wp-admin/includes/menu.php' );


Generated: Sat Nov 23 20:47:33 2019 Cross-referenced by PHPXref 0.7