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


Generated : Mon Mar 18 08:20:01 2024 Cross-referenced by PHPXref