3 * Displays Administration Menu.
6 * @subpackage Administration
12 * @global string $self
16 $self = preg_replace('|^.*/wp-admin/network/|i', '', $_SERVER['PHP_SELF']);
17 $self = preg_replace('|^.*/wp-admin/|i', '', $self);
18 $self = preg_replace('|^.*/plugins/|i', '', $self);
19 $self = preg_replace('|^.*/mu-plugins/|i', '', $self);
21 global $menu, $submenu, $parent_file; //For when admin-header is included from within a function.
24 * Filter the parent file of an admin menu sub-menu item.
26 * Allows plugins to move sub-menu items around.
30 * @param string $parent_file The parent file.
32 $parent_file = apply_filters( 'parent_file', $parent_file );
34 get_admin_page_parent();
43 * @param array $submenu
44 * @param bool $submenu_as_parent
46 function _wp_menu_output( $menu, $submenu, $submenu_as_parent = true ) {
47 global $self, $parent_file, $submenu_file, $plugin_page, $typenow;
50 // 0 = menu_title, 1 = capability, 2 = menu_slug, 3 = page_title, 4 = classes, 5 = hookname, 6 = icon_url
51 foreach ( $menu as $key => $item ) {
52 $admin_is_parent = false;
54 $aria_attributes = '';
57 $class[] = 'wp-first-item';
61 $submenu_items = false;
62 if ( ! empty( $submenu[$item[2]] ) ) {
63 $class[] = 'wp-has-submenu';
64 $submenu_items = $submenu[$item[2]];
67 if ( ( $parent_file && $item[2] == $parent_file ) || ( empty($typenow) && $self == $item[2] ) ) {
68 $class[] = ! empty( $submenu_items ) ? 'wp-has-current-submenu wp-menu-open' : 'current';
70 $class[] = 'wp-not-current-submenu';
71 if ( ! empty( $submenu_items ) )
72 $aria_attributes .= 'aria-haspopup="true"';
75 if ( ! empty( $item[4] ) )
76 $class[] = esc_attr( $item[4] );
78 $class = $class ? ' class="' . join( ' ', $class ) . '"' : '';
79 $id = ! empty( $item[5] ) ? ' id="' . preg_replace( '|[^a-zA-Z0-9_:.]|', '-', $item[5] ) . '"' : '';
80 $img = $img_style = '';
81 $img_class = ' dashicons-before';
84 * If the string 'none' (previously 'div') is passed instead of an URL, don't output
85 * the default menu image so an icon can be added to div.wp-menu-image as background
86 * with CSS. Dashicons and base64-encoded data:image/svg_xml URIs are also handled
89 if ( ! empty( $item[6] ) ) {
90 $img = '<img src="' . $item[6] . '" alt="" />';
92 if ( 'none' === $item[6] || 'div' === $item[6] ) {
94 } elseif ( 0 === strpos( $item[6], 'data:image/svg+xml;base64,' ) ) {
96 $img_style = ' style="background-image:url(\'' . esc_attr( $item[6] ) . '\')"';
98 } elseif ( 0 === strpos( $item[6], 'dashicons-' ) ) {
100 $img_class = ' dashicons-before ' . sanitize_html_class( $item[6] );
103 $arrow = '<div class="wp-menu-arrow"><div></div></div>';
105 $title = wptexturize( $item[0] );
107 echo "\n\t<li$class$id>";
109 if ( false !== strpos( $class, 'wp-menu-separator' ) ) {
110 echo '<div class="separator"></div>';
111 } elseif ( $submenu_as_parent && ! empty( $submenu_items ) ) {
112 $submenu_items = array_values( $submenu_items ); // Re-index.
113 $menu_hook = get_plugin_page_hook( $submenu_items[0][2], $item[2] );
114 $menu_file = $submenu_items[0][2];
115 if ( false !== ( $pos = strpos( $menu_file, '?' ) ) )
116 $menu_file = substr( $menu_file, 0, $pos );
117 if ( ! empty( $menu_hook ) || ( ( 'index.php' != $submenu_items[0][2] ) && file_exists( WP_PLUGIN_DIR . "/$menu_file" ) && ! file_exists( ABSPATH . "/wp-admin/$menu_file" ) ) ) {
118 $admin_is_parent = true;
119 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>";
121 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>";
123 } elseif ( ! empty( $item[2] ) && current_user_can( $item[1] ) ) {
124 $menu_hook = get_plugin_page_hook( $item[2], 'admin.php' );
125 $menu_file = $item[2];
126 if ( false !== ( $pos = strpos( $menu_file, '?' ) ) )
127 $menu_file = substr( $menu_file, 0, $pos );
128 if ( ! empty( $menu_hook ) || ( ( 'index.php' != $item[2] ) && file_exists( WP_PLUGIN_DIR . "/$menu_file" ) && ! file_exists( ABSPATH . "/wp-admin/$menu_file" ) ) ) {
129 $admin_is_parent = true;
130 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>";
132 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>";
136 if ( ! empty( $submenu_items ) ) {
137 echo "\n\t<ul class='wp-submenu wp-submenu-wrap'>";
138 echo "<li class='wp-submenu-head'>{$item[0]}</li>";
142 // 0 = menu_title, 1 = capability, 2 = menu_slug, 3 = page_title, 4 = classes
143 foreach ( $submenu_items as $sub_key => $sub_item ) {
144 if ( ! current_user_can( $sub_item[1] ) )
149 $class[] = 'wp-first-item';
153 $menu_file = $item[2];
155 if ( false !== ( $pos = strpos( $menu_file, '?' ) ) )
156 $menu_file = substr( $menu_file, 0, $pos );
158 // Handle current for post_type=post|page|foo pages, which won't match $self.
159 $self_type = ! empty( $typenow ) ? $self . '?post_type=' . $typenow : 'nothing';
161 if ( isset( $submenu_file ) ) {
162 if ( $submenu_file == $sub_item[2] )
163 $class[] = 'current';
164 // If plugin_page is set the parent must either match the current page or not physically exist.
165 // This allows plugin pages with the same hook to exist under different parents.
167 ( ! isset( $plugin_page ) && $self == $sub_item[2] ) ||
168 ( isset( $plugin_page ) && $plugin_page == $sub_item[2] && ( $item[2] == $self_type || $item[2] == $self || file_exists($menu_file) === false ) )
170 $class[] = 'current';
173 if ( ! empty( $sub_item[4] ) ) {
174 $class[] = esc_attr( $sub_item[4] );
177 $class = $class ? ' class="' . join( ' ', $class ) . '"' : '';
179 $menu_hook = get_plugin_page_hook($sub_item[2], $item[2]);
180 $sub_file = $sub_item[2];
181 if ( false !== ( $pos = strpos( $sub_file, '?' ) ) )
182 $sub_file = substr($sub_file, 0, $pos);
184 $title = wptexturize($sub_item[0]);
186 if ( ! empty( $menu_hook ) || ( ( 'index.php' != $sub_item[2] ) && file_exists( WP_PLUGIN_DIR . "/$sub_file" ) && ! file_exists( ABSPATH . "/wp-admin/$sub_file" ) ) ) {
187 // If admin.php is the current page or if the parent exists as a file in the plugins or admin dir
188 if ( ( ! $admin_is_parent && file_exists( WP_PLUGIN_DIR . "/$menu_file" ) && ! is_dir( WP_PLUGIN_DIR . "/{$item[2]}" ) ) || file_exists( $menu_file ) )
189 $sub_item_url = add_query_arg( array( 'page' => $sub_item[2] ), $item[2] );
191 $sub_item_url = add_query_arg( array( 'page' => $sub_item[2] ), 'admin.php' );
193 $sub_item_url = esc_url( $sub_item_url );
194 echo "<li$class><a href='$sub_item_url'$class>$title</a></li>";
196 echo "<li$class><a href='{$sub_item[2]}'$class>$title</a></li>";
204 echo '<li id="collapse-menu" class="hide-if-no-js"><div id="collapse-button"><div></div></div>';
205 echo '<span>' . esc_html__( 'Collapse menu' ) . '</span>';
211 <div id="adminmenuback"></div>
212 <div id="adminmenuwrap">
213 <ul id="adminmenu" role="navigation">
217 _wp_menu_output( $menu, $submenu );
219 * Fires after the admin menu has been output.
223 do_action( 'adminmenu' );