| [ 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 $first = true; 77 // 0 = menu_title, 1 = capability, 2 = menu_slug, 3 = page_title, 4 = classes, 5 = hookname, 6 = icon_url. 78 foreach ( $menu as $key => $item ) { 79 $admin_is_parent = false; 80 $class = array(); 81 $aria_attributes = ''; 82 $aria_hidden = ''; 83 $is_separator = false; 84 85 if ( $first ) { 86 $class[] = 'wp-first-item'; 87 $first = false; 88 } 89 90 $submenu_items = array(); 91 if ( ! empty( $submenu[ $item[2] ] ) ) { 92 $class[] = 'wp-has-submenu'; 93 $submenu_items = $submenu[ $item[2] ]; 94 } 95 96 if ( ( $parent_file && $item[2] === $parent_file ) || ( empty( $typenow ) && $self === $item[2] ) ) { 97 if ( ! empty( $submenu_items ) ) { 98 $class[] = 'wp-has-current-submenu wp-menu-open'; 99 } else { 100 $class[] = 'current'; 101 $aria_attributes .= 'aria-current="page"'; 102 } 103 } else { 104 $class[] = 'wp-not-current-submenu'; 105 if ( ! empty( $submenu_items ) ) { 106 $aria_attributes .= 'data-ariahaspopup'; 107 } 108 } 109 110 if ( ! empty( $item[4] ) ) { 111 $class[] = esc_attr( $item[4] ); 112 } 113 114 $class = ' class="' . implode( ' ', $class ) . '"'; 115 $id = ! empty( $item[5] ) ? ' id="' . preg_replace( '|[^a-zA-Z0-9_:.]|', '-', $item[5] ) . '"' : ''; 116 $img = ''; 117 $img_style = ''; 118 $img_class = ' dashicons-before'; 119 120 if ( str_contains( $class, 'wp-menu-separator' ) ) { 121 $is_separator = true; 122 } 123 124 /* 125 * If the string 'none' (previously 'div') is passed instead of a URL, don't output 126 * the default menu image so an icon can be added to div.wp-menu-image as background 127 * with CSS. Dashicons and base64-encoded data:image/svg_xml URIs are also handled 128 * as special cases. Namespaced icon names are rendered as inline SVG, or leave the 129 * menu image empty if the icon is not found. Any other value is treated as an image URL. 130 * 131 * Dashicons back-compat: the `$menu` global keeps the Dashicons of the menu items, 132 * including the core ones. Dashicons with a registered replacement icon are only 133 * mapped to it here, when the menu is rendered, and other Dashicons are rendered 134 * with the Dashicons font. 135 */ 136 if ( ! empty( $item[6] ) ) { 137 $img = '<img src="' . esc_url( $item[6] ) . '" alt="" />'; 138 $icon_name = WP_Icons_Registry::get_instance()->get_admin_icon_name_for_dashicon( $item[6] ) ?? $item[6]; 139 140 if ( 'none' === $item[6] || 'div' === $item[6] ) { 141 $img = '<br />'; 142 } elseif ( str_starts_with( $item[6], 'data:image/svg+xml;base64,' ) ) { 143 $img = '<br />'; 144 // The value is base64-encoded data, so esc_attr() is used here instead of esc_url(). 145 $img_style = ' style="background-image:url(\'' . esc_attr( $item[6] ) . '\')"'; 146 $img_class = ' svg'; 147 } elseif ( wp_is_valid_icon_name( $icon_name ) ) { 148 $img = '<br />'; 149 $icon = wp_get_icon( $icon_name ); 150 if ( '' !== $icon ) { 151 $img = $icon; 152 $img_class = ' dashicons-before svg-icon'; 153 } elseif ( ! WP_Icons_Registry::get_instance()->is_registered( $icon_name ) ) { 154 _doing_it_wrong( 155 __FUNCTION__, 156 sprintf( 157 /* translators: 1: Icon name, 2: Admin menu item slug. */ 158 __( 'The icon "%1$s" of the admin menu item "%2$s" is not registered.' ), 159 $icon_name, 160 $item[2] 161 ), 162 '7.2.0' 163 ); 164 } 165 } elseif ( str_starts_with( $item[6], 'dashicons-' ) ) { 166 $img = '<br />'; 167 $img_class = ' dashicons-before ' . sanitize_html_class( $item[6] ); 168 } 169 } 170 171 $title = wptexturize( $item[0] ); 172 173 // Hide separators from screen readers. 174 if ( $is_separator ) { 175 $aria_hidden = ' aria-hidden="true"'; 176 } 177 178 echo "\n\t<li$class$id$aria_hidden>"; 179 180 if ( $is_separator ) { 181 echo '<div class="separator"></div>'; 182 } elseif ( $submenu_as_parent && ! empty( $submenu_items ) ) { 183 $submenu_items = array_values( $submenu_items ); // Re-index. 184 $menu_hook = get_plugin_page_hook( $submenu_items[0][2], $item[2] ); 185 $menu_file = $submenu_items[0][2]; 186 $pos = strpos( $menu_file, '?' ); 187 188 if ( false !== $pos ) { 189 $menu_file = substr( $menu_file, 0, $pos ); 190 } 191 192 if ( ! empty( $menu_hook ) 193 || ( ( 'index.php' !== $submenu_items[0][2] ) 194 && file_exists( WP_PLUGIN_DIR . "/$menu_file" ) 195 && ! file_exists( ABSPATH . "/wp-admin/$menu_file" ) ) 196 ) { 197 $admin_is_parent = true; 198 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>"; 199 } else { 200 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>"; 201 } 202 } elseif ( ! empty( $item[2] ) && current_user_can( $item[1] ) ) { 203 $menu_hook = get_plugin_page_hook( $item[2], 'admin.php' ); 204 $menu_file = $item[2]; 205 $pos = strpos( $menu_file, '?' ); 206 207 if ( false !== $pos ) { 208 $menu_file = substr( $menu_file, 0, $pos ); 209 } 210 211 if ( ! empty( $menu_hook ) 212 || ( ( 'index.php' !== $item[2] ) 213 && file_exists( WP_PLUGIN_DIR . "/$menu_file" ) 214 && ! file_exists( ABSPATH . "/wp-admin/$menu_file" ) ) 215 ) { 216 $admin_is_parent = true; 217 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>"; 218 } else { 219 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>"; 220 } 221 } 222 223 if ( ! empty( $submenu_items ) ) { 224 echo "\n\t<ul class='wp-submenu wp-submenu-wrap'>"; 225 echo "<li class='wp-submenu-head' aria-hidden='true'>{$item[0]}</li>"; 226 227 $first = true; 228 229 // 0 = menu_title, 1 = capability, 2 = menu_slug, 3 = page_title, 4 = classes. 230 foreach ( $submenu_items as $sub_key => $sub_item ) { 231 if ( ! current_user_can( $sub_item[1] ) ) { 232 continue; 233 } 234 235 $class = array(); 236 $aria_attributes = ''; 237 238 if ( $first ) { 239 $class[] = 'wp-first-item'; 240 $first = false; 241 } 242 243 $menu_file = $item[2]; 244 $pos = strpos( $menu_file, '?' ); 245 246 if ( false !== $pos ) { 247 $menu_file = substr( $menu_file, 0, $pos ); 248 } 249 250 // Handle current for post_type=post|page|foo pages, which won't match $self. 251 $self_type = ! empty( $typenow ) ? $self . '?post_type=' . $typenow : 'nothing'; 252 253 if ( isset( $submenu_file ) ) { 254 if ( $submenu_file === $sub_item[2] ) { 255 $class[] = 'current'; 256 $aria_attributes .= ' aria-current="page"'; 257 } 258 /* 259 * If plugin_page is set the parent must either match the current page or not physically exist. 260 * This allows plugin pages with the same hook to exist under different parents. 261 */ 262 } elseif ( 263 ( ! isset( $plugin_page ) && $self === $sub_item[2] ) 264 || ( isset( $plugin_page ) && $plugin_page === $sub_item[2] 265 && ( $item[2] === $self_type || $item[2] === $self || file_exists( $menu_file ) === false ) ) 266 ) { 267 $class[] = 'current'; 268 $aria_attributes .= ' aria-current="page"'; 269 } 270 271 if ( ! empty( $sub_item[4] ) ) { 272 $class[] = esc_attr( $sub_item[4] ); 273 } 274 275 $class = $class ? ' class="' . implode( ' ', $class ) . '"' : ''; 276 277 $menu_hook = get_plugin_page_hook( $sub_item[2], $item[2] ); 278 $sub_file = $sub_item[2]; 279 $pos = strpos( $sub_file, '?' ); 280 if ( false !== $pos ) { 281 $sub_file = substr( $sub_file, 0, $pos ); 282 } 283 284 $title = wptexturize( $sub_item[0] ); 285 286 if ( ! empty( $menu_hook ) 287 || ( ( 'index.php' !== $sub_item[2] ) 288 && file_exists( WP_PLUGIN_DIR . "/$sub_file" ) 289 && ! file_exists( ABSPATH . "/wp-admin/$sub_file" ) ) 290 ) { 291 // If admin.php is the current page or if the parent exists as a file in the plugins or admin directory. 292 if ( ( ! $admin_is_parent && file_exists( WP_PLUGIN_DIR . "/$menu_file" ) && ! is_dir( WP_PLUGIN_DIR . "/{$item[2]}" ) ) || file_exists( $menu_file ) ) { 293 $sub_item_url = add_query_arg( array( 'page' => $sub_item[2] ), $item[2] ); 294 } else { 295 $sub_item_url = add_query_arg( array( 'page' => $sub_item[2] ), 'admin.php' ); 296 } 297 298 $sub_item_url = esc_url( $sub_item_url ); 299 echo "<li$class><a href='$sub_item_url'$class$aria_attributes>$title</a></li>"; 300 } else { 301 echo "<li$class><a href='{$sub_item[2]}'$class$aria_attributes>$title</a></li>"; 302 } 303 } 304 echo '</ul>'; 305 } 306 echo '</li>'; 307 } 308 309 echo '<li id="collapse-menu" class="hide-if-no-js">' . 310 '<button type="button" id="collapse-button" aria-label="' . esc_attr__( 'Collapse Main Menu' ) . '" aria-expanded="true">' . 311 '<span class="collapse-button-icon" aria-hidden="true">' . wp_get_icon( 'core-admin/chevron-left' ) . '</span>' . 312 '<span class="collapse-button-label">' . __( 'Collapse Menu' ) . '</span>' . 313 '</button></li>'; 314 } 315 316 ?> 317 318 <div id="adminmenumain" role="navigation" aria-label="<?php esc_attr_e( 'Main menu' ); ?>"> 319 <a href="#wpbody-content" class="screen-reader-shortcut"><?php _e( 'Skip to main content' ); ?></a> 320 <a href="#wp-toolbar" class="screen-reader-shortcut"><?php _e( 'Skip to toolbar' ); ?></a> 321 <div id="adminmenuback"></div> 322 <div id="adminmenuwrap"> 323 <ul id="adminmenu"> 324 325 <?php 326 327 _wp_menu_output( $menu, $submenu ); 328 /** 329 * Fires after the admin menu has been output. 330 * 331 * @since 2.5.0 332 */ 333 do_action( 'adminmenu' ); 334 335 ?> 336 </ul> 337 </div> 338 </div>
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
| Generated : Sat Nov 14 08:20:01 2026 | Cross-referenced by PHPXref |