X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/b3ddbea8a296025a672b3c3ddca158dc51ed8080..888fa4ed68091f3314f711c5f6fe75858bf5410b:/wp-admin/includes/menu.php

diff --git a/wp-admin/includes/menu.php b/wp-admin/includes/menu.php
index fa85e4b5..6835091a 100644
--- a/wp-admin/includes/menu.php
+++ b/wp-admin/includes/menu.php
@@ -1,5 +1,4 @@
 <?php
-
 /**
  * Build Administration Menu.
  *
@@ -7,12 +6,40 @@
  * @subpackage Administration
  */
 
-if ( is_network_admin() )
-	do_action('_network_admin_menu');
-elseif ( is_user_admin() )
-	do_action('_user_admin_menu');
-else
-	do_action('_admin_menu');
+if ( is_network_admin() ) {
+
+	/**
+	 * Fires before the administration menu loads in the Network Admin.
+	 *
+	 * The hook fires before menus and sub-menus are removed based on user privileges.
+	 *
+	 * @private
+	 * @since 3.1.0
+	 */
+	do_action( '_network_admin_menu' );
+} elseif ( is_user_admin() ) {
+
+	/**
+	 * Fires before the administration menu loads in the User Admin.
+	 *
+	 * The hook fires before menus and sub-menus are removed based on user privileges.
+	 *
+	 * @private
+	 * @since 3.1.0
+	 */
+	do_action( '_user_admin_menu' );
+} else {
+
+	/**
+	 * Fires before the administration menu loads in the admin.
+	 *
+	 * The hook fires before menus and sub-menus are removed based on user privileges.
+	 *
+	 * @private
+	 * @since 2.2.0
+	 */
+	do_action( '_admin_menu' );
+}
 
 // Create list of page plugin hook names.
 foreach ($menu as $menu_page) {
@@ -61,9 +88,11 @@ foreach ( array( 'submenu' ) as $sub_loop ) {
 }
 unset($sub_loop);
 
-// Loop over the top-level menu.
-// Menus for which the original parent is not accessible due to lack of privs will have the next
-// submenu in line be assigned as the new menu parent.
+/*
+ * Loop over the top-level menu.
+ * Menus for which the original parent is not accessible due to lack of privileges
+ * will have the next submenu in line be assigned as the new menu parent.
+ */
 foreach ( $menu as $id => $data ) {
 	if ( empty($submenu[$data[2]]) )
 		continue;
@@ -89,21 +118,50 @@ foreach ( $menu as $id => $data ) {
 }
 unset($id, $data, $subs, $first_sub, $old_parent, $new_parent);
 
-if ( is_network_admin() )
-	do_action('network_admin_menu', '');
-elseif ( is_user_admin() )
-	do_action('user_admin_menu', '');
-else
-	do_action('admin_menu', '');
+if ( is_network_admin() ) {
+
+	/**
+	 * Fires before the administration menu loads in the Network Admin.
+	 *
+	 * @since 3.1.0
+	 *
+	 * @param string $context Empty context.
+	 */
+	do_action( 'network_admin_menu', '' );
+} elseif ( is_user_admin() ) {
+
+	/**
+	 * Fires before the administration menu loads in the User Admin.
+	 *
+	 * @since 3.1.0
+	 *
+	 * @param string $context Empty context.
+	 */
+	do_action( 'user_admin_menu', '' );
+} else {
+
+	/**
+	 * Fires before the administration menu loads in the admin.
+	 *
+	 * @since 1.5.0
+	 *
+	 * @param string $context Empty context.
+	 */
+	do_action( 'admin_menu', '' );
+}
 
-// Remove menus that have no accessible submenus and require privs that the user does not have.
-// Run re-parent loop again.
+/*
+ * Remove menus that have no accessible submenus and require privileges
+ * that the user does not have. Run re-parent loop again.
+ */
 foreach ( $menu as $id => $data ) {
 	if ( ! current_user_can($data[1]) )
 		$_wp_menu_nopriv[$data[2]] = true;
 
-	// If there is only one submenu and it is has same destination as the parent,
-	// remove the submenu.
+	/*
+	 * If there is only one submenu and it is has same destination as the parent,
+	 * remove the submenu.
+	 */
 	if ( ! empty( $submenu[$data[2]] ) && 1 == count ( $submenu[$data[2]] ) ) {
 		$subs = $submenu[$data[2]];
 		$first_sub = array_shift($subs);
@@ -156,7 +214,7 @@ function add_menu_classes($menu) {
 			continue;
 		}
 
-		if ( 0 === strpos($top[2], 'separator') ) { // if separator
+		if ( 0 === strpos($top[2], 'separator') && false !== $lastorder ) { // if separator
 			$first = true;
 			$c = $menu[$lastorder][4];
 			$menu[$lastorder][4] = add_cssclass('menu-top-last', $c);
@@ -177,19 +235,48 @@ function add_menu_classes($menu) {
 		$lastorder = $order;
 	}
 
+	/**
+	 * Filter administration menus array with classes added for top-level items.
+	 *
+	 * @since 2.7.0
+	 *
+	 * @param array $menu Associative array of administration menu items.
+	 */
 	return apply_filters( 'add_menu_classes', $menu );
 }
 
 uksort($menu, "strnatcasecmp"); // make it all pretty
 
-if ( apply_filters('custom_menu_order', false) ) {
+/**
+ * Filter whether to enable custom ordering of the administration menu.
+ *
+ * See the 'menu_order' filter for reordering menu items.
+ *
+ * @since 2.8.0
+ *
+ * @param bool $custom Whether custom ordering is enabled. Default false.
+ */
+if ( apply_filters( 'custom_menu_order', false ) ) {
 	$menu_order = array();
 	foreach ( $menu as $menu_item ) {
 		$menu_order[] = $menu_item[2];
 	}
 	unset($menu_item);
 	$default_menu_order = $menu_order;
-	$menu_order = apply_filters('menu_order', $menu_order);
+
+	/**
+	 * Filter the order of administration menu items.
+	 *
+	 * A truthy value must first be passed to the 'custom_menu_order' filter
+	 * for this filter to work. Use the following to enable custom menu ordering:
+	 *
+	 *     add_filter( 'custom_menu_order', '__return_true' );
+	 *
+	 * @since 2.8.0
+	 *
+	 * @param array $menu_order An ordered array of menu items.
+	 */
+	$menu_order = apply_filters( 'menu_order', $menu_order );
 	$menu_order = array_flip($menu_order);
 	$default_menu_order = array_flip($default_menu_order);
 
@@ -215,16 +302,22 @@ if ( apply_filters('custom_menu_order', false) ) {
 }
 
 // Remove the last menu item if it is a separator.
-$last_menu_key = array_pop( array_keys( $menu ) );
-if ( 'wp-menu-separator' == $menu[ $last_menu_key ][ 4 ] )
+$last_menu_key = array_keys( $menu );
+$last_menu_key = array_pop( $last_menu_key );
+if ( !empty( $menu ) && 'wp-menu-separator' == $menu[ $last_menu_key ][ 4 ] )
 	unset( $menu[ $last_menu_key ] );
 unset( $last_menu_key );
 
 if ( !user_can_access_admin_page() ) {
-	do_action('admin_page_access_denied');
+
+	/**
+	 * Fires when access to an admin page is denied.
+	 *
+	 * @since 2.5.0
+	 */
+	do_action( 'admin_page_access_denied' );
+
 	wp_die( __('You do not have sufficient permissions to access this page.') );
 }
 
 $menu = add_menu_classes($menu);
-
-?>
\ No newline at end of file