Changeset 15753

Timestamp:

10/07/2010 10:35:31 PM (14 years ago)

Author:

scribu

Message:

Introduce remove_menu_page() and remove_submenu_page(). Fixes #12718

File:

• trunk/wp-admin/includes/plugin.php (modified) (15 diffs)

trunk/wp-admin/includes/plugin.php

@@ -853 +853 @@
  * Add a top level menu page in the 'objects' section
  *
- * This function takes a capability which will be used to determine whether
- * or not a page is included in the menu.
- *
- * The function which is hooked in to handle the output of the page must check
- * that the user has the required capability as well.
- *
  * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
  * @param string $menu_title The text to be used for the menu
@@ -877 +871 @@
  * Add a top level menu page in the 'utility' section
  *
- * This function takes a capability which will be used to determine whether
- * or not a page is included in the menu.
- *
- * The function which is hooked in to handle the output of the page must check
- * that the user has the required capability as well.
- *
  * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
  * @param string $menu_title The text to be used for the menu
@@ -900 +888 @@
 /**
  * Add a sub menu page
- *
- * This function takes a capability which will be used to determine whether
- * or not a page is included in the menu.
- *
- * The function which is hooked in to handle the output of the page must check
- * that the user has the required capability as well.
  *
  * @param string $parent_slug The slug name for the parent menu (or the file name of a standard WordPress admin page)
@@ -963 +945 @@
 /**
  * Add sub menu page to the tools main menu.
-*
- * This function takes a capability which will be used to determine whether
- * or not a page is included in the menu.
- *
- * The function which is hooked in to handle the output of the page must check
- * that the user has the required capability as well.
  *
  * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
@@ -982 +958 @@
 /**
  * Add sub menu page to the options main menu.
-*
- * This function takes a capability which will be used to determine whether
- * or not a page is included in the menu.
- *
- * The function which is hooked in to handle the output of the page must check
- * that the user has the required capability as well.
  *
  * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
@@ -1001 +971 @@
 /**
  * Add sub menu page to the themes main menu.
-*
- * This function takes a capability which will be used to determine whether
- * or not a page is included in the menu.
- *
- * The function which is hooked in to handle the output of the page must check
- * that the user has the required capability as well.
  *
  * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
@@ -1020 +984 @@
 /**
  * Add sub menu page to the plugins main menu.
-*
- * This function takes a capability which will be used to determine whether
- * or not a page is included in the menu.
- *
- * The function which is hooked in to handle the output of the page must check
- * that the user has the required capability as well.
  *
  * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
@@ -1039 +997 @@
 /**
  * Add sub menu page to the Users/Profile main menu.
-*
- * This function takes a capability which will be used to determine whether
- * or not a page is included in the menu.
- *
- * The function which is hooked in to handle the output of the page must check
- * that the user has the required capability as well.
  *
  * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
@@ -1061 +1013 @@
 /**
  * Add sub menu page to the Dashboard main menu.
-*
- * This function takes a capability which will be used to determine whether
- * or not a page is included in the menu.
- *
- * The function which is hooked in to handle the output of the page must check
- * that the user has the required capability as well.
  *
  * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
@@ -1080 +1026 @@
 /**
  * Add sub menu page to the posts main menu.
-*
- * This function takes a capability which will be used to determine whether
- * or not a page is included in the menu.
- *
- * The function which is hooked in to handle the output of the page must check
- * that the user has the required capability as well.
  *
  * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
@@ -1099 +1039 @@
 /**
  * Add sub menu page to the media main menu.
-*
- * This function takes a capability which will be used to determine whether
- * or not a page is included in the menu.
- *
- * The function which is hooked in to handle the output of the page must check
- * that the user has the required capability as well.
  *
  * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
@@ -1118 +1052 @@
 /**
  * Add sub menu page to the links main menu.
-*
- * This function takes a capability which will be used to determine whether
- * or not a page is included in the menu.
- *
- * The function which is hooked in to handle the output of the page must check
- * that the user has the required capability as well.
  *
  * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
@@ -1137 +1065 @@
 /**
  * Add sub menu page to the pages main menu.
-*
- * This function takes a capability which will be used to determine whether
- * or not a page is included in the menu.
- *
- * The function which is hooked in to handle the output of the page must check
- * that the user has the required capability as well.
  *
  * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
@@ -1156 +1078 @@
 /**
  * Add sub menu page to the comments main menu.
-*
- * This function takes a capability which will be used to determine whether
- * or not a page is included in the menu.
- *
- * The function which is hooked in to handle the output of the page must check
- * that the user has the required capability as well.
  *
  * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
@@ -1171 +1087 @@
 function add_comments_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
     return add_submenu_page( 'edit-comments.php', $page_title, $menu_title, $capability, $menu_slug, $function );
+}
+
+
+/**
+ * Remove a top level admin menu
+ *
+ * @since 3.1.0
+ *
+ * @param string $menu_slug The slug of the menu
+ * @return array|bool The removed menu on success, False if not found
+ */
+function remove_menu_page( $menu_slug ) {
+    global $menu;
+
+    foreach ( $menu as $i => $item ) {
+        if ( $menu_slug == $item[2] ) {
+            unset( $menu[$i] );
+            return $item;
+        }
+    }
+
+    return false;
+}
+
+/**
+ * Remove an admin submenu
+ *
+ * @since 3.1.0
+ *
+ * @param string $menu_slug The slug for the parent menu
+ * @param string $submenu_slug The slug of the submenu
+ * @return array|bool The removed submenu on success, False if not found
+ */
+function remove_submenu_page( $menu_slug, $submenu_slug ) {
+    global $submenu;
+
+    if ( !isset( $submenu[$menu_slug] ) )
+        return false;
+
+    foreach ( $submenu[$menu_slug] as $i => $item ) {
+        if ( $submenu_slug == $item[2] ) {
+            unset( $submenu[$menu_slug][$i] );
+            return $item;
+        }
+    }
+
+    return false;
 }