Changeset 6503

Timestamp:

11/09/2012 04:28:30 PM (12 years ago)

Author:

djpaul

Message:

Introduces bp_nav_menu(), which displays a merged navigation list from registered components. Fixes #4629.

BP has historically used bp_get_displayed_user_nav() and bp_get_options_nav() to render the navigation, and these menus have always been visually separate in the Default theme; either in columns before 1.2, and in rows since 1.2.

To provide more customisation for theme authors, and have both parts of the navigation displayed in the same block, this change introduces a merged menu function, with the parts from bp_get_options_nav nested appropriately under bp_get_displayed_user_nav.

Location:

trunk/bp-core

Files:

• bp-core-classes.php (modified) (1 diff)
• bp-core-template.php (modified) (1 diff)

trunk/bp-core/bp-core-classes.php

@@ -1797 +1797 @@
     }
 }
+
+/**
+ * Create HTML list of BP nav items
+ *
+ * @since BuddyPress (1.7)
+ */
+class BP_Walker_Nav_Menu extends Walker_Nav_Menu {
+    /**
+     * @since BuddyPress (1.7)
+     * @var array
+     */
+    var $db_fields = array( 'id' => 'css_id', 'parent' => 'parent' );
+
+    /**
+     * @since BuddyPress (1.7)
+     * @var string
+     */
+    var $tree_type = array();
+
+    /**
+     * Display array of elements hierarchically.
+     *
+     * This method is almost identical to the version in {@link Walker::walk()}. The only change is on one line
+     * which has been commented. An IF was comparing 0 to a non-empty string which was preventing child elements
+     * being grouped under their parent menu element.
+     *
+     * This caused a problem for BuddyPress because our primary/secondary navigations doesn't have a unique numerical
+     * ID that describes a hierarchy (we use a slug). Obviously, WordPress Menus use Posts, and those have ID/post_parent.
+     *
+     * @param array $elements
+     * @param int $max_depth
+     * @return string
+     * @see Walker::walk()
+     * @since BuddyPress (1.7)
+     */
+    function walk( $elements, $max_depth ) {
+        $args   = array_slice( func_get_args(), 2 );
+        $output = '';
+
+        if ( $max_depth < -1 ) // invalid parameter
+            return $output;
+
+        if ( empty( $elements ) ) // nothing to walk
+            return $output;
+
+        $id_field     = $this->db_fields['id'];
+        $parent_field = $this->db_fields['parent'];
+
+        // flat display
+        if ( -1 == $max_depth ) {
+
+            $empty_array = array();
+            foreach ( $elements as $e )
+                $this->display_element( $e, $empty_array, 1, 0, $args, $output );
+
+            return $output;
+        }
+
+        /*
+         * need to display in hierarchical order
+         * separate elements into two buckets: top level and children elements
+         * children_elements is two dimensional array, eg.
+         * children_elements[10][] contains all sub-elements whose parent is 10.
+         */
+        $top_level_elements = array();
+        $children_elements  = array();
+
+        foreach ( $elements as $e ) {
+            // BuddyPress: changed '==' to '==='. This is the only change from version in Walker::walk().
+            if ( 0 === $e->$parent_field )
+                $top_level_elements[] = $e;
+            else
+                $children_elements[$e->$parent_field][] = $e;
+        }
+
+        /*
+         * when none of the elements is top level
+         * assume the first one must be root of the sub elements
+         */
+        if ( empty( $top_level_elements ) ) {
+
+            $first              = array_slice( $elements, 0, 1 );
+            $root               = $first[0];
+            $top_level_elements = array();
+            $children_elements  = array();
+
+            foreach ( $elements as $e ) {
+                if ( $root->$parent_field == $e->$parent_field )
+                    $top_level_elements[] = $e;
+                else
+                    $children_elements[$e->$parent_field][] = $e;
+            }
+        }
+
+        foreach ( $top_level_elements as $e )
+            $this->display_element( $e, $children_elements, $max_depth, 0, $args, $output );
+
+        /*
+         * if we are displaying all levels, and remaining children_elements is not empty,
+         * then we got orphans, which should be displayed regardless
+         */
+        if ( ( $max_depth == 0 ) && count( $children_elements ) > 0 ) {
+            $empty_array = array();
+
+            foreach ( $children_elements as $orphans )
+                foreach ( $orphans as $op )
+                    $this->display_element( $op, $empty_array, 1, 0, $args, $output );
+         }
+
+         return $output;
+    }
+
+    /**
+     * Displays the current <li> that we are on.
+     *
+     * @param string $output Passed by reference. Used to append additional content.
+     * @param object $item Menu item data object.
+     * @param int $depth Depth of menu item. Used for padding. Optional, defaults to 0.
+     * @param array $args Optional
+     * @param int $current_page Menu item ID. Optional.
+     * @since BuddyPress (1.7)
+     */
+    function start_el( &$output, $item, $depth = 0, $args = array(), $id = 0 ) {
+        // If we're someway down the tree, indent the HTML with the appropriate number of tabs
+        $indent = $depth ? str_repeat( "\t", $depth ) : '';
+
+        // Add HTML classes
+        $class_names = join( ' ', apply_filters( 'bp_nav_menu_css_class', array_filter( $item->class ), $item, $args ) );
+        $class_names = ! empty( $class_names ) ? ' class="' . esc_attr( $class_names ) . '"' : '';
+
+        // Add HTML ID
+        $id = sanitize_html_class( $item->css_id . '-personal-li' );  // Backpat with BP pre-1.7
+        $id = apply_filters( 'bp_nav_menu_item_id', $id, $item, $args );
+        $id = ! empty( $id ) ? ' id="' . esc_attr( $id ) . '"' : '';
+
+        // Opening tag; closing tag is handled in Walker_Nav_Menu::end_el().
+        $output .= $indent . '<li' . $id . $class_names . '>';
+
+        // Add href attribute
+        $attributes = ! empty( $item->link ) ? ' href="' . esc_attr( esc_url( $item->link ) ) . '"' : '';
+
+        // Construct the link
+        $item_output = $args->before;
+        $item_output .= '<a' . $attributes . '>';
+        $item_output .= $args->link_before . apply_filters( 'the_title', $item->name, 0 ) . $args->link_after;
+        $item_output .= '</a>';
+        $item_output .= $args->after;
+
+        // $output is byref
+        $output .= apply_filters( 'bp_walker_nav_menu_start_el', $item_output, $item, $depth, $args );
+    }
+}

trunk/bp-core/bp-core-template.php

@@ -1743 +1743 @@
     }
     add_filter( 'body_class', 'bp_get_the_body_class', 10, 2 );
+
+/**
+ * Sort BuddyPress nav menu items by their position property.
+ *
+ * This is an internal convenience function and it will probably be removed in a later release. Do not use.
+ *
+ * @access private
+ * @param array $a First item
+ * @param array $b Second item
+ * @return int Returns an integer less than, equal to, or greater than zero if the first argument is considered to be respectively less than, equal to, or greater than the second.
+ * @since BuddyPress (1.7)
+ */
+function _bp_nav_menu_sort( $a, $b ) {
+    if ( $a["position"] == $b["position"] )
+        return 0;
+
+    else if ( $a["position"] < $b["position"] )
+        return -1;
+
+    else
+        return 1;
+}
+
+/**
+ * Get an array of all the items registered in the primary and secondary BuddyPress navigation menus
+ *
+ * @return array
+ * @since BuddyPress (1.7)
+ */
+function bp_get_nav_menu_items() {
+    $menus = $selected_menus = array();
+
+    // Get the second level menus
+    foreach ( (array) buddypress()->bp_options_nav as $parent_menu => $sub_menus ) {
+
+        // The root menu's ID is "xprofile", but the Profile submenus are using "profile". See BP_Core::setup_nav().
+        if ( 'profile' == $parent_menu )
+            $parent_menu = 'xprofile';
+
+        // Sort the items in this menu's navigation by their position property
+        $second_level_menus = (array) $sub_menus;
+        usort( $second_level_menus, '_bp_nav_menu_sort' );
+
+        // Iterate through the second level menus
+        foreach( $second_level_menus as $sub_nav ) {
+
+            // Skip items we don't have access to
+            if ( ! $sub_nav['user_has_access'] )
+                continue;
+
+            // Add this menu
+            $menu         = new stdClass;
+            $menu->class  = array();
+            $menu->css_id = $sub_nav['css_id'];
+            $menu->link   = $sub_nav['link'];
+            $menu->name   = $sub_nav['name'];
+            $menu->parent = $parent_menu;  // Associate this sub nav with a top-level menu
+
+            // If we're viewing this item's screen, record that we need to mark its parent menu to be selected
+            if ( $sub_nav['slug'] == bp_current_action() ) {
+                $menu->class      = array( 'current-menu-item' );
+                $selected_menus[] = $parent_menu;
+            }
+
+            $menus[] = $menu;
+        }
+    }
+
+    // Get the top-level menu parts (Friends, Groups, etc) and sort by their position property
+    $top_level_menus = (array) buddypress()->bp_nav;
+    usort( $top_level_menus, '_bp_nav_menu_sort' );
+
+    // Iterate through the top-level menus
+    foreach ( $top_level_menus as $nav ) {
+
+        // Skip items marked as user-specific if you're not on your own profile
+        if ( ! $nav['show_for_displayed_user'] && ! bp_is_my_profile() )
+            continue;
+
+        // Get the correct menu link. See http://buddypress.trac.wordpress.org/ticket/4624
+        $link = bp_loggedin_user_domain() ? str_replace( bp_loggedin_user_domain(), bp_displayed_user_domain(), $nav['link'] ) : trailingslashit( bp_displayed_user_domain() . $nav['link'] );
+
+        // Add this menu
+        $menu         = new stdClass;
+        $menu->class  = array();
+        $menu->css_id = $nav['css_id'];
+        $menu->link   = $link;
+        $menu->name   = $nav['name'];
+        $menu->parent = 0;
+
+        // Check if we need to mark this menu as selected
+        if ( in_array( $nav['css_id'], $selected_menus ) )
+            $menu->class = array( 'current-menu-parent' );
+
+        $menus[] = $menu;
+    }
+
+    return apply_filters( 'bp_get_nav_menu_items', $menus );
+}
+
+/**
+ * Displays a navigation menu.
+ *
+ * @param string|array $args Optional arguments:
+ *  before - Text before the link text.
+ *  container - Whether to wrap the ul, and what to wrap it with. Defaults to div.
+ *  container_class - The class that is applied to the container. Defaults to 'menu-bp-container'.
+ *  container_id - The ID that is applied to the container. Defaults to blank.
+ *  depth - How many levels of the hierarchy are to be included. 0 means all. Defaults to 0.
+ *  echo - Whether to echo the menu or return it. Defaults to echo.
+ *  fallback_cb - If the menu doesn't exists, a callback function will fire. Defaults to false (no fallback).
+ *  items_wrap - How the list items should be wrapped. Defaults to a ul with an id and class. Uses printf() format with numbered placeholders.
+ *  link_after - Text after the link.
+ *  link_before - Text before the link.
+ *  menu_class - CSS class to use for the ul element which forms the menu. Defaults to 'menu'.
+ *  menu_id - The ID that is applied to the ul element which forms the menu. Defaults to 'menu-bp', incremented.
+ *  walker - Allows a custom walker to be specified. Defaults to 'BP_Walker_Nav_Menu'.
+ * @since BuddyPress (1.7)
+ */
+function bp_nav_menu( $args = array() ) {
+    static $menu_id_slugs = array();
+
+    $defaults = array(
+        'after'           => '',
+        'before'          => '',
+        'container'       => 'div',
+        'container_class' => '',
+        'container_id'    => '',
+        'depth'           => 0,
+        'echo'            => true,
+        'fallback_cb'     => false,
+        'items_wrap'      => '<ul id="%1$s" class="%2$s">%3$s</ul>',
+        'link_after'      => '',
+        'link_before'     => '',
+        'menu_class'      => 'menu',
+        'menu_id'         => '',
+        'walker'          => '',
+    );
+    $args = wp_parse_args( $args, $defaults );
+    $args = apply_filters( 'bp_nav_menu_args', $args );
+    $args = (object) $args;
+
+    $items = $nav_menu = '';
+    $show_container = false;
+
+    // Create custom walker if one wasn't set
+    if ( empty( $args->walker ) )
+        $args->walker = new BP_Walker_Nav_Menu;
+
+    // Sanitise values for class and ID
+    $args->container_class = sanitize_html_class( $args->container_class );
+    $args->container_id    = sanitize_html_class( $args->container_id );
+
+    // Whether to wrap the ul, and what to wrap it with
+    if ( $args->container ) {
+        $allowed_tags = apply_filters( 'wp_nav_menu_container_allowedtags', array( 'div', 'nav', ) );
+
+        if ( in_array( $args->container, $allowed_tags ) ) {
+            $show_container = true;
+
+            $class     = $args->container_class ? ' class="' . esc_attr( $args->container_class ) . '"' : ' class="menu-bp-container"';
+            $id        = $args->container_id    ? ' id="' . esc_attr( $args->container_id ) . '"'       : '';
+            $nav_menu .= '<' . $args->container . $id . $class . '>';
+        }
+    }
+
+    // Get the BuddyPress menu items
+    $menu_items = apply_filters( 'bp_nav_menu_objects', bp_get_nav_menu_items(), $args );
+    $items      = walk_nav_menu_tree( $menu_items, $args->depth, $args );
+    unset( $menu_items );
+
+    // Set the ID that is applied to the ul element which forms the menu.
+    if ( ! empty( $args->menu_id ) ) {
+        $wrap_id = $args->menu_id;
+
+    } else {
+        $wrap_id = 'menu-bp';
+
+        // If a specific ID wasn't requested, and there are multiple menus on the same screen, make sure the autogenerated ID is unique
+        while ( in_array( $wrap_id, $menu_id_slugs ) ) {
+            if ( preg_match( '#-(\d+)$#', $wrap_id, $matches ) )
+                $wrap_id = preg_replace('#-(\d+)$#', '-' . ++$matches[1], $wrap_id );
+            else
+                $wrap_id = $wrap_id . '-1';
+        }
+    }
+    $menu_id_slugs[] = $wrap_id;
+
+    // Allow plugins to hook into the menu to add their own <li>'s
+    $items = apply_filters( 'bp_nav_menu_items', $items, $args );
+
+    // Build the output
+    $wrap_class  = $args->menu_class ? $args->menu_class : '';
+    $nav_menu   .= sprintf( $args->items_wrap, esc_attr( $wrap_id ), esc_attr( $wrap_class ), $items );
+    unset( $items );
+
+    // If we've wrapped the ul, close it
+    if ( $show_container )
+        $nav_menu .= '</' . $args->container . '>';
+
+    // Final chance to modify output
+    $nav_menu = apply_filters( 'bp_nav_menu', $nav_menu, $args );
+
+    if ( $args->echo )
+        echo $nav_menu;
+    else
+        return $nav_menu;
+}