Changeset 7454 for trunk/bp-core/bp-core-component.php

Timestamp:

10/22/2013 07:31:29 PM (12 years ago)

Author:

r-a-y

Message:

Add a fourth parameter to the BP_Component::start() method.

This parameter is an array that allows extended classes to define some
properties that need to be set early one for BP_Component to be able
to work its magic.

Currently accepts 'adminbar_myaccount_order', which sets a custom
position for the component menu generated under the WP Toolbar's
"My Account" menu. If this value isn't set, we set the value to 90,
which will generate the menu before the Settings menu is added.

Fixes #3769.

File:

• trunk/bp-core/bp-core-component.php (modified) (4 diffs)

trunk/bp-core/bp-core-component.php

@@ -115 +115 @@
      * @since BuddyPress (1.5.0)
      *
-     * @uses bp_Component::setup_actions() Set up the hooks and actions.
+     * @uses BP_Component::setup_actions() Set up the hooks and actions.
      *
      * @param string $id Unique ID (for internal identification). Letters,
@@ -123 +123 @@
      * @param string $path The file path for the component's files. Used by
      *        {@link BP_Component::includes()}.
-     */
-    public function start( $id = '', $name = '', $path = '' ) {
+     * @param array $params Additional parameters used by the component.
+     *        The config array supports the following values:
+     *        - 'adminbar_myaccount_order' Sets the position for our
+     *          component menu under the WP Toolbar's "My Account" menu.
+     */
+    public function start( $id = '', $name = '', $path = '', $params = array() ) {
 
         // Internal identifier of component
@@ -134 +138 @@
         // Path for includes
         $this->path = $path;
+
+        // Miscellaneous component parameters that need to be set early on
+        if ( ! empty( $params ) ) {
+            // Sets the position for our menu under the WP Toolbar's "My Account" menu
+            if ( ! empty( $params['adminbar_myaccount_order'] ) ) {
+                $this->adminbar_myaccount_order = (int) $params['adminbar_myaccount_order'];
+            }
+
+        // Set defaults if not passed
+        } else {
+            // new component menus are added before the settings menu if not set
+            $this->adminbar_myaccount_order = 90;
+        }
 
         // Move on to the next step
@@ -305 +322 @@
 
         // Setup WP Toolbar menus
-        add_action( 'bp_setup_admin_bar',        array( $this, 'setup_admin_bar'        ), 10 );
+        add_action( 'bp_setup_admin_bar',        array( $this, 'setup_admin_bar'        ), $this->adminbar_myaccount_order );
 
         // Setup component title