[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

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

   1  <?php
   2  /**
   3   * Displays Administration Menu.
   4   *
   5   * @package WordPress
   6   * @subpackage Administration
   7   */
   8  
   9  /**
  10   * The current page.
  11   *
  12   * @global string $self
  13   */
  14  $self = preg_replace( '|^.*/wp-admin/network/|i', '', $_SERVER['PHP_SELF'] );
  15  $self = preg_replace( '|^.*/wp-admin/|i', '', $self );
  16  $self = preg_replace( '|^.*/plugins/|i', '', $self );
  17  $self = preg_replace( '|^.*/mu-plugins/|i', '', $self );
  18  
  19  /**
  20   * For when admin-header is included from within a function.
  21   *
  22   * @global array  $menu
  23   * @global array  $submenu
  24   * @global string $parent_file
  25   * @global string $submenu_file
  26   */
  27  global $menu, $submenu, $parent_file, $submenu_file;
  28  
  29  /**
  30   * Filters the parent file of an admin menu sub-menu item.
  31   *
  32   * Allows plugins to move sub-menu items around.
  33   *
  34   * @since MU (3.0.0)
  35   *
  36   * @param string $parent_file The parent file.
  37   */
  38  $parent_file = apply_filters( 'parent_file', $parent_file );
  39  
  40  /**
  41   * Filters the file of an admin menu sub-menu item.
  42   *
  43   * @since 4.4.0
  44   *
  45   * @param string $submenu_file The submenu file.
  46   * @param string $parent_file  The submenu item's parent file.
  47   */
  48  $submenu_file = apply_filters( 'submenu_file', $submenu_file, $parent_file );
  49  
  50  get_admin_page_parent();
  51  
  52  /**
  53   * Display menu.
  54   *
  55   * @access private
  56   * @since 2.7.0
  57   *
  58   * @global string $self
  59   * @global string $parent_file
  60   * @global string $submenu_file
  61   * @global string $plugin_page
  62   * @global string $typenow      The post type of the current screen.
  63   *
  64   * @param array $menu
  65   * @param array $submenu
  66   * @param bool  $submenu_as_parent
  67   */
  68  function _wp_menu_output( $menu, $submenu, $submenu_as_parent = true ) {
  69      global $self, $parent_file, $submenu_file, $plugin_page, $typenow;
  70  
  71      $first = true;
  72      // 0 = menu_title, 1 = capability, 2 = menu_slug, 3 = page_title, 4 = classes, 5 = hookname, 6 = icon_url.
  73      foreach ( $menu as $key => $item ) {
  74          $admin_is_parent = false;
  75          $class           = array();
  76          $aria_attributes = '';
  77          $aria_hidden     = '';
  78          $is_separator    = false;
  79  
  80          if ( $first ) {
  81              $class[] = 'wp-first-item';
  82              $first   = false;
  83          }
  84  
  85          $submenu_items = array();
  86          if ( ! empty( $submenu[ $item[2] ] ) ) {
  87              $class[]       = 'wp-has-submenu';
  88              $submenu_items = $submenu[ $item[2] ];
  89          }
  90  
  91          if ( ( $parent_file && $item[2] === $parent_file ) || ( empty( $typenow ) && $self === $item[2] ) ) {
  92              if ( ! empty( $submenu_items ) ) {
  93                  $class[] = 'wp-has-current-submenu wp-menu-open';
  94              } else {
  95                  $class[]          = 'current';
  96                  $aria_attributes .= 'aria-current="page"';
  97              }
  98          } else {
  99              $class[] = 'wp-not-current-submenu';
 100              if ( ! empty( $submenu_items ) ) {
 101                  $aria_attributes .= 'aria-haspopup="true"';
 102              }
 103          }
 104  
 105          if ( ! empty( $item[4] ) ) {
 106              $class[] = esc_attr( $item[4] );
 107          }
 108  
 109          $class     = $class ? ' class="' . implode( ' ', $class ) . '"' : '';
 110          $id        = ! empty( $item[5] ) ? ' id="' . preg_replace( '|[^a-zA-Z0-9_:.]|', '-', $item[5] ) . '"' : '';
 111          $img       = '';
 112          $img_style = '';
 113          $img_class = ' dashicons-before';
 114  
 115          if ( false !== strpos( $class, 'wp-menu-separator' ) ) {
 116              $is_separator = true;
 117          }
 118  
 119          /*
 120           * If the string 'none' (previously 'div') is passed instead of a URL, don't output
 121           * the default menu image so an icon can be added to div.wp-menu-image as background
 122           * with CSS. Dashicons and base64-encoded data:image/svg_xml URIs are also handled
 123           * as special cases.
 124           */
 125          if ( ! empty( $item[6] ) ) {
 126              $img = '<img src="' . esc_url( $item[6] ) . '" alt="" />';
 127  
 128              if ( 'none' === $item[6] || 'div' === $item[6] ) {
 129                  $img = '<br />';
 130              } elseif ( 0 === strpos( $item[6], 'data:image/svg+xml;base64,' ) ) {
 131                  $img = '<br />';
 132                  // The value is base64-encoded data, so esc_attr() is used here instead of esc_url().
 133                  $img_style = ' style="background-image:url(\'' . esc_attr( $item[6] ) . '\')"';
 134                  $img_class = ' svg';
 135              } elseif ( 0 === strpos( $item[6], 'dashicons-' ) ) {
 136                  $img       = '<br />';
 137                  $img_class = ' dashicons-before ' . sanitize_html_class( $item[6] );
 138              }
 139          }
 140          $arrow = '<div class="wp-menu-arrow"><div></div></div>';
 141  
 142          $title = wptexturize( $item[0] );
 143  
 144          // Hide separators from screen readers.
 145          if ( $is_separator ) {
 146              $aria_hidden = ' aria-hidden="true"';
 147          }
 148  
 149          echo "\n\t<li$class$id$aria_hidden>";
 150  
 151          if ( $is_separator ) {
 152              echo '<div class="separator"></div>';
 153          } elseif ( $submenu_as_parent && ! empty( $submenu_items ) ) {
 154              $submenu_items = array_values( $submenu_items );  // Re-index.
 155              $menu_hook     = get_plugin_page_hook( $submenu_items[0][2], $item[2] );
 156              $menu_file     = $submenu_items[0][2];
 157              $pos           = strpos( $menu_file, '?' );
 158  
 159              if ( false !== $pos ) {
 160                  $menu_file = substr( $menu_file, 0, $pos );
 161              }
 162  
 163              if ( ! empty( $menu_hook )
 164                  || ( ( 'index.php' !== $submenu_items[0][2] )
 165                      && file_exists( WP_PLUGIN_DIR . "/$menu_file" )
 166                      && ! file_exists( ABSPATH . "/wp-admin/$menu_file" ) )
 167              ) {
 168                  $admin_is_parent = true;
 169                  echo "<a href='admin.php?page={$submenu_items[0][2]}'$class $aria_attributes>$arrow<div class='wp-menu-image$img_class'$img_style aria-hidden='true'>$img</div><div class='wp-menu-name'>$title</div></a>";
 170              } else {
 171                  echo "\n\t<a href='{$submenu_items[0][2]}'$class $aria_attributes>$arrow<div class='wp-menu-image$img_class'$img_style aria-hidden='true'>$img</div><div class='wp-menu-name'>$title</div></a>";
 172              }
 173          } elseif ( ! empty( $item[2] ) && current_user_can( $item[1] ) ) {
 174              $menu_hook = get_plugin_page_hook( $item[2], 'admin.php' );
 175              $menu_file = $item[2];
 176              $pos       = strpos( $menu_file, '?' );
 177  
 178              if ( false !== $pos ) {
 179                  $menu_file = substr( $menu_file, 0, $pos );
 180              }
 181  
 182              if ( ! empty( $menu_hook )
 183                  || ( ( 'index.php' !== $item[2] )
 184                      && file_exists( WP_PLUGIN_DIR . "/$menu_file" )
 185                      && ! file_exists( ABSPATH . "/wp-admin/$menu_file" ) )
 186              ) {
 187                  $admin_is_parent = true;
 188                  echo "\n\t<a href='admin.php?page={$item[2]}'$class $aria_attributes>$arrow<div class='wp-menu-image$img_class'$img_style aria-hidden='true'>$img</div><div class='wp-menu-name'>{$item[0]}</div></a>";
 189              } else {
 190                  echo "\n\t<a href='{$item[2]}'$class $aria_attributes>$arrow<div class='wp-menu-image$img_class'$img_style aria-hidden='true'>$img</div><div class='wp-menu-name'>{$item[0]}</div></a>";
 191              }
 192          }
 193  
 194          if ( ! empty( $submenu_items ) ) {
 195              echo "\n\t<ul class='wp-submenu wp-submenu-wrap'>";
 196              echo "<li class='wp-submenu-head' aria-hidden='true'>{$item[0]}</li>";
 197  
 198              $first = true;
 199  
 200              // 0 = menu_title, 1 = capability, 2 = menu_slug, 3 = page_title, 4 = classes.
 201              foreach ( $submenu_items as $sub_key => $sub_item ) {
 202                  if ( ! current_user_can( $sub_item[1] ) ) {
 203                      continue;
 204                  }
 205  
 206                  $class           = array();
 207                  $aria_attributes = '';
 208  
 209                  if ( $first ) {
 210                      $class[] = 'wp-first-item';
 211                      $first   = false;
 212                  }
 213  
 214                  $menu_file = $item[2];
 215                  $pos       = strpos( $menu_file, '?' );
 216  
 217                  if ( false !== $pos ) {
 218                      $menu_file = substr( $menu_file, 0, $pos );
 219                  }
 220  
 221                  // Handle current for post_type=post|page|foo pages, which won't match $self.
 222                  $self_type = ! empty( $typenow ) ? $self . '?post_type=' . $typenow : 'nothing';
 223  
 224                  if ( isset( $submenu_file ) ) {
 225                      if ( $submenu_file === $sub_item[2] ) {
 226                          $class[]          = 'current';
 227                          $aria_attributes .= ' aria-current="page"';
 228                      }
 229                      // If plugin_page is set the parent must either match the current page or not physically exist.
 230                      // This allows plugin pages with the same hook to exist under different parents.
 231                  } elseif (
 232                      ( ! isset( $plugin_page ) && $self === $sub_item[2] )
 233                      || ( isset( $plugin_page ) && $plugin_page === $sub_item[2]
 234                          && ( $item[2] === $self_type || $item[2] === $self || file_exists( $menu_file ) === false ) )
 235                  ) {
 236                      $class[]          = 'current';
 237                      $aria_attributes .= ' aria-current="page"';
 238                  }
 239  
 240                  if ( ! empty( $sub_item[4] ) ) {
 241                      $class[] = esc_attr( $sub_item[4] );
 242                  }
 243  
 244                  $class = $class ? ' class="' . implode( ' ', $class ) . '"' : '';
 245  
 246                  $menu_hook = get_plugin_page_hook( $sub_item[2], $item[2] );
 247                  $sub_file  = $sub_item[2];
 248                  $pos       = strpos( $sub_file, '?' );
 249                  if ( false !== $pos ) {
 250                      $sub_file = substr( $sub_file, 0, $pos );
 251                  }
 252  
 253                  $title = wptexturize( $sub_item[0] );
 254  
 255                  if ( ! empty( $menu_hook )
 256                      || ( ( 'index.php' !== $sub_item[2] )
 257                          && file_exists( WP_PLUGIN_DIR . "/$sub_file" )
 258                          && ! file_exists( ABSPATH . "/wp-admin/$sub_file" ) )
 259                  ) {
 260                      // If admin.php is the current page or if the parent exists as a file in the plugins or admin directory.
 261                      if ( ( ! $admin_is_parent && file_exists( WP_PLUGIN_DIR . "/$menu_file" ) && ! is_dir( WP_PLUGIN_DIR . "/{$item[2]}" ) ) || file_exists( $menu_file ) ) {
 262                          $sub_item_url = add_query_arg( array( 'page' => $sub_item[2] ), $item[2] );
 263                      } else {
 264                          $sub_item_url = add_query_arg( array( 'page' => $sub_item[2] ), 'admin.php' );
 265                      }
 266  
 267                      $sub_item_url = esc_url( $sub_item_url );
 268                      echo "<li$class><a href='$sub_item_url'$class$aria_attributes>$title</a></li>";
 269                  } else {
 270                      echo "<li$class><a href='{$sub_item[2]}'$class$aria_attributes>$title</a></li>";
 271                  }
 272              }
 273              echo '</ul>';
 274          }
 275          echo '</li>';
 276      }
 277  
 278      echo '<li id="collapse-menu" class="hide-if-no-js">' .
 279          '<button type="button" id="collapse-button" aria-label="' . esc_attr__( 'Collapse Main menu' ) . '" aria-expanded="true">' .
 280          '<span class="collapse-button-icon" aria-hidden="true"></span>' .
 281          '<span class="collapse-button-label">' . __( 'Collapse menu' ) . '</span>' .
 282          '</button></li>';
 283  }
 284  
 285  ?>
 286  
 287  <div id="adminmenumain" role="navigation" aria-label="<?php esc_attr_e( 'Main menu' ); ?>">
 288  <a href="#wpbody-content" class="screen-reader-shortcut"><?php _e( 'Skip to main content' ); ?></a>
 289  <a href="#wp-toolbar" class="screen-reader-shortcut"><?php _e( 'Skip to toolbar' ); ?></a>
 290  <div id="adminmenuback"></div>
 291  <div id="adminmenuwrap">
 292  <ul id="adminmenu">
 293  
 294  <?php
 295  
 296  _wp_menu_output( $menu, $submenu );
 297  /**
 298   * Fires after the admin menu has been output.
 299   *
 300   * @since 2.5.0
 301   */
 302  do_action( 'adminmenu' );
 303  
 304  ?>
 305  </ul>
 306  </div>
 307  </div>


Generated: Tue May 17 01:00:03 2022 Cross-referenced by PHPXref 0.7.1