Changeset 4309

Timestamp:

04/30/2011 10:41:47 AM (14 years ago)

Author:

djpaul

Message:

Deprecate bp_core_add_admin_menu_page() in favour of add_menu_page(). Fixes #3184

Location:

trunk/bp-core

Files:

• admin/bp-core-update.php (modified) (2 diffs)
• bp-core-functions.php (modified) (3 diffs)
• deprecated/1.3.php (modified) (1 diff)

trunk/bp-core/admin/bp-core-update.php

@@ -1139 +1139 @@
 }
 
-/**
- * A better version of add_admin_menu_page() that allows positioning of menus.
- *
- * @package BuddyPress Core
- */
-function bp_core_update_add_admin_menu_page( $args = '' ) {
-    global $menu, $admin_page_hooks, $_registered_pages;
-
-    $defaults = array(
-        'page_title' => '',
-        'menu_title' => '',
-        'capability' => 'manage_options',
-        'menu_slug'  => '',
-        'function'   => false,
-        'icon_url'   => false,
-        'position'   => 100
-    );
-
-    $r = wp_parse_args( $args, $defaults );
-    extract( $r, EXTR_SKIP );
-
-    if ( is_multisite() )
-        add_menu_page( $page_title, $menu_title, $capability, $menu_slug, $function, $icon_url, $position );
-    else
-        add_menu_page( $page_title, $menu_title, $capability, $menu_slug, $function, $icon_url, $position );
-}
-
 function bp_core_wizard_message() {
     if ( isset( $_GET['updated'] ) )
@@ -1227 +1200 @@
 
     // Add the administration tab under the "Site Admin" tab for site administrators
-    bp_core_update_add_admin_menu_page( array(
-        'menu_title' => __( 'BuddyPress', 'buddypress' ),
-        'page_title' => __( 'BuddyPress', 'buddypress' ),
-        'capability' => 'manage_options',
-        'menu_slug'  => 'bp-wizard',
-        'function'   => '',
-        'position'   => 3
-    ) );
-
+    add_menu_page( __( 'BuddyPress', 'buddypress' ), __( 'BuddyPress', 'buddypress' ), 'manage_options', 'bp-wizard', '', '', 3 );
     $hook = add_submenu_page( 'bp-wizard', $status, $status, 'manage_options', 'bp-wizard', array( $bp_wizard, 'html' ) );
 

trunk/bp-core/bp-core-functions.php

@@ -194 +194 @@
 
     // Add the administration tab under the "Site Admin" tab for site administrators
-    $hooks[] = bp_core_add_admin_menu_page( array(
-        'menu_title' => __( 'BuddyPress', 'buddypress' ),
-        'page_title' => __( 'BuddyPress', 'buddypress' ),
-        'capability' => 'manage_options',
-        'file'       => 'bp-general-settings',
-        'function'   => 'bp_core_admin_component_setup',
-        'position'   => 2
-    ) );
+    $hooks[] = add_menu_page( __( 'BuddyPress', 'buddypress' ), __( 'BuddyPress', 'buddypress' ), 'manage_options', 'bp-general-settings', 'bp_core_admin_component_setup', '', 2 );
 
     $hooks[] = add_submenu_page( 'bp-general-settings', __( 'Components', 'buddypress' ), __( 'Components', 'buddypress' ), 'manage_options', 'bp-general-settings', 'bp_core_admin_component_setup'  );
@@ -209 +202 @@
     foreach( $hooks as $hook )
         add_action( "admin_print_styles-$hook", 'bp_core_add_admin_menu_styles' );
-
 }
 add_action( is_multisite() ? 'network_admin_menu' : 'admin_menu', 'bp_core_add_admin_menu', 9 );
@@ -817 +809 @@
 }
 add_action( 'wp_footer', 'bp_core_print_generation_time' );
-
-/**
- * A better version of add_admin_menu_page() that allows positioning of menus.
- *
- * @package BuddyPress Core
- */
-function bp_core_add_admin_menu_page( $args = '' ) {
-    global $menu, $admin_page_hooks, $_registered_pages;
-
-    $defaults = array(
-        'page_title'   => '',
-        'menu_title'   => '',
-        'capability'   => 'manage_options',
-        'file'         => false,
-        'function'     => false,
-        'icon_url'     => false,
-        'position'     => 100
-    );
-
-    $r = wp_parse_args( $args, $defaults );
-    extract( $r, EXTR_SKIP );
-
-    $file                    = plugin_basename( $file );
-    $admin_page_hooks[$file] = sanitize_title( $menu_title );
-    $hookname                = get_plugin_page_hookname( $file, '' );
-
-    if (!empty ( $function ) && !empty ( $hookname ))
-        add_action( $hookname, $function );
-
-    if ( empty( $icon_url ) )
-        $icon_url = esc_url( admin_url( 'images/generic.png' ) );
-    elseif ( is_ssl() && 0 === strpos($icon_url, 'http://') )
-        $icon_url = 'https://' . substr($icon_url, 7);
-
-    do {
-        $position++;
-    } while ( !empty( $menu[$position] ) );
-
-    $menu[$position] = array ( $menu_title, $capability, $file, $page_title, 'menu-top ' . $hookname, $hookname, $icon_url );
-
-    $_registered_pages[$hookname] = true;
-
-    return $hookname;
-}
 
 /**

trunk/bp-core/deprecated/1.3.php

@@ -49 +49 @@
 }
 
+/** Admin ******************************************************************/
+
+/**
+ * In BuddyPress 1.1 - 1.2.x, this function provided a better version of add_menu_page()
+ * that allowed positioning of menus. Deprecated in 1.3 in favour of a WP core function.
+ *
+ * @deprecated 1.3
+ * @deprecated Use add_menu_page().
+ * @since 1.1
+ */
+function bp_core_add_admin_menu_page( $args = '' ) {
+    $defaults = array(
+        'page_title'   => '',
+        'menu_title'   => '',
+        'capability'   => 'manage_options',
+        'file'         => '',
+        'function'     => '',
+        'icon_url'     => '',
+        'position'     => 100
+    );
+
+    $r = wp_parse_args( $args, $defaults );
+    extract( $r, EXTR_SKIP );
+
+    _deprecated_function( __FUNCTION__, '1.3', 'Use add_menu_page()' );
+    return add_menu_page( $page_title, $menu_title, $capability, $file, $function, $icon_url, $position );
+}
+
 /** Activity ******************************************************************/