[ Index ]

PHP Cross Reference of WordPress Trunk (Updated Daily)

Search

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


Generated : Thu Jan 30 08:20:01 2025 Cross-referenced by PHPXref