Contents

Code Reference Classes BP_Walker_Nav_Menu

BP_Walker_Nav_Menu

Create HTML list of BP nav items.

Description

Source

File: bp-core/classes/class-bp-walker-nav-menu.php

17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
class BP_Walker_Nav_Menu extends Walker_Nav_Menu {
 
    /**
     * Description of fields indexes for building markup.
     *
     * @since BuddyPress 1.7.0
     * @var array
     */
    var $db_fields = array( 'id' => 'css_id', 'parent' => 'parent' );
 
    /**
     * Tree type.
     *
     * @since BuddyPress 1.7.0
     * @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 don'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.
     *
     * @since BuddyPress 1.7.0
     *
     * @see Walker::walk()
     *
     * @param array $elements  See {@link Walker::walk()}.
     * @param int   $max_depth See {@link Walker::walk()}.
     * @return string See {@link Walker::walk()}.
     */
    public 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;
 
        $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;
    }
 
    /**
     * Display the current <li> that we are on.
     *
     * @see Walker::start_el() for complete description of parameters.
     *
     * @since BuddyPress 1.7.0
     *
     * @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. See {@link Walker::start_el()}.
     * @param int    $id     Menu item ID. Optional.
     */
    public 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 ) : '';
 
        /**
         * Filters the classes to be added to the nav menu markup.
         *
         * @since BuddyPress 1.7.0
         *
         * @param array  $value Array of classes to be added.
         * @param object $item  Menu item data object.
         * @param array  $args  Array of arguments for the item.
         */
        $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.
 
        /**
         * Filters the value to be used for the nav menu ID attribute.
         *
         * @since BuddyPress 1.7.0
         *
         * @param string $id   ID attribute to be added to the menu item.
         * @param object $item Menu item data object.
         * @param array  $args Array of arguments for the item.
         */
        $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_url( $item->link ) . '"' : '';
 
        // Construct the link.
        $item_output = $args->before;
        $item_output .= '<a' . $attributes . '>';
 
        /**
         * Filters the link text to be added to the item output.
         *
         * @since BuddyPress 1.7.0
         *
         * @param string $name  Item text to be applied.
         * @param int    $value Post ID the title is for.
         */
        $item_output .= $args->link_before . apply_filters( 'the_title', $item->name, 0 ) . $args->link_after;
        $item_output .= '</a>';
        $item_output .= $args->after;
 
        /**
         * Filters the final result for the menu item.
         *
         * @since BuddyPress 1.7.0
         *
         * @param string $item_output Constructed output for the menu item to append to output.
         * @param object $item        Menu item data object.
         * @param int    $depth       Depth of menu item. Used for padding.
         * @param array  $args        Array of arguments for the item.
         */
        $output .= apply_filters( 'bp_walker_nav_menu_start_el', $item_output, $item, $depth, $args );
    }
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
BuddyPress 1.7.0 Introduced.

Methods

  • start_el — Display the current that we are on.
  • walk — Display array of elements hierarchically.

Questions?

We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.