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