3 * Displays Administration Menu.
6 * @subpackage Administration
12 * @global string $self
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);
20 * For when admin-header is included from within a function.
23 * @global array $submenu
24 * @global string $parent_file
26 global $menu, $submenu, $parent_file;
29 * Filter the parent file of an admin menu sub-menu item.
31 * Allows plugins to move sub-menu items around.
35 * @param string $parent_file The parent file.
37 $parent_file = apply_filters( 'parent_file', $parent_file );
39 get_admin_page_parent();
47 * @global string $self
48 * @global string $parent_file
49 * @global string $submenu_file
50 * @global string $plugin_page
51 * @global string $typenow
54 * @param array $submenu
55 * @param bool $submenu_as_parent
57 function _wp_menu_output( $menu, $submenu, $submenu_as_parent = true ) {
58 global $self, $parent_file, $submenu_file, $plugin_page, $typenow;
61 // 0 = menu_title, 1 = capability, 2 = menu_slug, 3 = page_title, 4 = classes, 5 = hookname, 6 = icon_url
62 foreach ( $menu as $key => $item ) {
63 $admin_is_parent = false;
65 $aria_attributes = '';
67 $is_separator = false;
70 $class[] = 'wp-first-item';
74 $submenu_items = array();
75 if ( ! empty( $submenu[$item[2]] ) ) {
76 $class[] = 'wp-has-submenu';
77 $submenu_items = $submenu[$item[2]];
80 if ( ( $parent_file && $item[2] == $parent_file ) || ( empty($typenow) && $self == $item[2] ) ) {
81 $class[] = ! empty( $submenu_items ) ? 'wp-has-current-submenu wp-menu-open' : 'current';
83 $class[] = 'wp-not-current-submenu';
84 if ( ! empty( $submenu_items ) )
85 $aria_attributes .= 'aria-haspopup="true"';
88 if ( ! empty( $item[4] ) )
89 $class[] = esc_attr( $item[4] );
91 $class = $class ? ' class="' . join( ' ', $class ) . '"' : '';
92 $id = ! empty( $item[5] ) ? ' id="' . preg_replace( '|[^a-zA-Z0-9_:.]|', '-', $item[5] ) . '"' : '';
93 $img = $img_style = '';
94 $img_class = ' dashicons-before';
96 if ( false !== strpos( $class, 'wp-menu-separator' ) ) {
101 * If the string 'none' (previously 'div') is passed instead of an URL, don't output
102 * the default menu image so an icon can be added to div.wp-menu-image as background
103 * with CSS. Dashicons and base64-encoded data:image/svg_xml URIs are also handled
106 if ( ! empty( $item[6] ) ) {
107 $img = '<img src="' . $item[6] . '" alt="" />';
109 if ( 'none' === $item[6] || 'div' === $item[6] ) {
111 } elseif ( 0 === strpos( $item[6], 'data:image/svg+xml;base64,' ) ) {
113 $img_style = ' style="background-image:url(\'' . esc_attr( $item[6] ) . '\')"';
115 } elseif ( 0 === strpos( $item[6], 'dashicons-' ) ) {
117 $img_class = ' dashicons-before ' . sanitize_html_class( $item[6] );
120 $arrow = '<div class="wp-menu-arrow"><div></div></div>';
122 $title = wptexturize( $item[0] );
124 // hide separators from screen readers
125 if ( $is_separator ) {
126 $aria_hidden = ' aria-hidden="true"';
129 echo "\n\t<li$class$id$aria_hidden>";
131 if ( $is_separator ) {
132 echo '<div class="separator"></div>';
133 } elseif ( $submenu_as_parent && ! empty( $submenu_items ) ) {
134 $submenu_items = array_values( $submenu_items ); // Re-index.
135 $menu_hook = get_plugin_page_hook( $submenu_items[0][2], $item[2] );
136 $menu_file = $submenu_items[0][2];
137 if ( false !== ( $pos = strpos( $menu_file, '?' ) ) )
138 $menu_file = substr( $menu_file, 0, $pos );
139 if ( ! empty( $menu_hook ) || ( ( 'index.php' != $submenu_items[0][2] ) && file_exists( WP_PLUGIN_DIR . "/$menu_file" ) && ! file_exists( ABSPATH . "/wp-admin/$menu_file" ) ) ) {
140 $admin_is_parent = true;
141 echo "<a href='admin.php?page={$submenu_items[0][2]}'$class $aria_attributes>$arrow<div class='wp-menu-image$img_class'$img_style>$img</div><div class='wp-menu-name'>$title</div></a>";
143 echo "\n\t<a href='{$submenu_items[0][2]}'$class $aria_attributes>$arrow<div class='wp-menu-image$img_class'$img_style>$img</div><div class='wp-menu-name'>$title</div></a>";
145 } elseif ( ! empty( $item[2] ) && current_user_can( $item[1] ) ) {
146 $menu_hook = get_plugin_page_hook( $item[2], 'admin.php' );
147 $menu_file = $item[2];
148 if ( false !== ( $pos = strpos( $menu_file, '?' ) ) )
149 $menu_file = substr( $menu_file, 0, $pos );
150 if ( ! empty( $menu_hook ) || ( ( 'index.php' != $item[2] ) && file_exists( WP_PLUGIN_DIR . "/$menu_file" ) && ! file_exists( ABSPATH . "/wp-admin/$menu_file" ) ) ) {
151 $admin_is_parent = true;
152 echo "\n\t<a href='admin.php?page={$item[2]}'$class $aria_attributes>$arrow<div class='wp-menu-image$img_class'$img_style>$img</div><div class='wp-menu-name'>{$item[0]}</div></a>";
154 echo "\n\t<a href='{$item[2]}'$class $aria_attributes>$arrow<div class='wp-menu-image$img_class'$img_style>$img</div><div class='wp-menu-name'>{$item[0]}</div></a>";
158 if ( ! empty( $submenu_items ) ) {
159 echo "\n\t<ul class='wp-submenu wp-submenu-wrap'>";
160 echo "<li class='wp-submenu-head' aria-hidden='true'>{$item[0]}</li>";
164 // 0 = menu_title, 1 = capability, 2 = menu_slug, 3 = page_title, 4 = classes
165 foreach ( $submenu_items as $sub_key => $sub_item ) {
166 if ( ! current_user_can( $sub_item[1] ) )
171 $class[] = 'wp-first-item';
175 $menu_file = $item[2];
177 if ( false !== ( $pos = strpos( $menu_file, '?' ) ) )
178 $menu_file = substr( $menu_file, 0, $pos );
180 // Handle current for post_type=post|page|foo pages, which won't match $self.
181 $self_type = ! empty( $typenow ) ? $self . '?post_type=' . $typenow : 'nothing';
183 if ( isset( $submenu_file ) ) {
184 if ( $submenu_file == $sub_item[2] )
185 $class[] = 'current';
186 // If plugin_page is set the parent must either match the current page or not physically exist.
187 // This allows plugin pages with the same hook to exist under different parents.
189 ( ! isset( $plugin_page ) && $self == $sub_item[2] ) ||
190 ( isset( $plugin_page ) && $plugin_page == $sub_item[2] && ( $item[2] == $self_type || $item[2] == $self || file_exists($menu_file) === false ) )
192 $class[] = 'current';
195 if ( ! empty( $sub_item[4] ) ) {
196 $class[] = esc_attr( $sub_item[4] );
199 $class = $class ? ' class="' . join( ' ', $class ) . '"' : '';
201 $menu_hook = get_plugin_page_hook($sub_item[2], $item[2]);
202 $sub_file = $sub_item[2];
203 if ( false !== ( $pos = strpos( $sub_file, '?' ) ) )
204 $sub_file = substr($sub_file, 0, $pos);
206 $title = wptexturize($sub_item[0]);
208 if ( ! empty( $menu_hook ) || ( ( 'index.php' != $sub_item[2] ) && file_exists( WP_PLUGIN_DIR . "/$sub_file" ) && ! file_exists( ABSPATH . "/wp-admin/$sub_file" ) ) ) {
209 // If admin.php is the current page or if the parent exists as a file in the plugins or admin dir
210 if ( ( ! $admin_is_parent && file_exists( WP_PLUGIN_DIR . "/$menu_file" ) && ! is_dir( WP_PLUGIN_DIR . "/{$item[2]}" ) ) || file_exists( $menu_file ) )
211 $sub_item_url = add_query_arg( array( 'page' => $sub_item[2] ), $item[2] );
213 $sub_item_url = add_query_arg( array( 'page' => $sub_item[2] ), 'admin.php' );
215 $sub_item_url = esc_url( $sub_item_url );
216 echo "<li$class><a href='$sub_item_url'$class>$title</a></li>";
218 echo "<li$class><a href='{$sub_item[2]}'$class>$title</a></li>";
226 echo '<li id="collapse-menu" class="hide-if-no-js"><div id="collapse-button"><div></div></div>';
227 echo '<span>' . esc_html__( 'Collapse menu' ) . '</span>';
233 <div id="adminmenumain" role="navigation" aria-label="<?php esc_attr_e( 'Main menu' ); ?>">
234 <a href="#wpbody-content" class="screen-reader-shortcut"><?php _e( 'Skip to main content' ); ?></a>
235 <a href="#wp-toolbar" class="screen-reader-shortcut"><?php _e( 'Skip to toolbar' ); ?></a>
236 <div id="adminmenuback"></div>
237 <div id="adminmenuwrap">
242 _wp_menu_output( $menu, $submenu );
244 * Fires after the admin menu has been output.
248 do_action( 'adminmenu' );