[ Index ]

PHP Cross Reference of WordPress

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


Generated: Mon Jan 24 01:00:08 2022 Cross-referenced by PHPXref 0.7.1