Contents

Code Reference Classes BP_Buttons_Group

BP_Buttons_Group

Builds a group of BP_Button

Description

Source

File: bp-templates/bp-nouveau/includes/classes.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
class BP_Buttons_Group {
 
    /**
     * The parameters of the Group of buttons
     *
     * @var array
     */
    protected $group = array();
 
    /**
     * Constructor
     *
     * @since BuddyPress 3.0.0
     *
     * @param array $args Optional array having the following parameters {
     *     @type string $id                A string to use as the unique ID for the button. Required.
     *     @type int    $position          Where to insert the Button. Defaults to 99.
     *     @type string $component         The Component's the button is build for (eg: Activity, Groups..). Required.
     *     @type bool   $must_be_logged_in Whether the button should only be displayed to logged in users. Defaults to True.
     *     @type bool   $block_self        Optional. True if the button should be hidden when a user is viewing his own profile.
     *                                     Defaults to False.
     *     @type string $parent_element    Whether to use a wrapper. Defaults to false.
     *     @type string $parent_attr       set an array of attributes for the parent element.
     *     @type string $button_element    Set this to 'button', 'img', or 'a', defaults to anchor.
     *     @type string $button_attr       Any attributes required for the button_element
     *     @type string $link_text         The text of the link. Required.
     * }
     */
    public function __construct( $args = array() ) {
        foreach ( $args as $arg ) {
            $this->set( $arg );
        }
    }
 
    /**
     * Set the button
     *
     * @since BuddyBoss 1.0.0
     *
     * @param array $args Optional array having the following parameters {
     *     @type string $id                A string to use as the unique ID for the button. Required.
     *     @type int    $position          Where to insert the Button. Defaults to 99.
     *     @type string $component         The Component's the button is build for (eg: Activity, Groups..). Required.
     *     @type bool   $must_be_logged_in Whether the button should only be displayed to logged in users. Defaults to True.
     *     @type bool   $block_self        Optional. True if the button should be hidden when a user is viewing his own profile.
     *                                     Defaults to False.
     *     @type string $parent_element    Whether to use a wrapper. Defaults to false.
     *     @type string $parent_attr       set an array of attributes for the parent element.
     *     @type string $button_element    Set this to 'button', 'img', or 'a', defaults to anchor.
     *     @type string $button_attr       Any attributes required for the button_element
     *     @type string $link_text         The text of the link. Required.
     * }
     */
    public function set( $args = array() ) {
 
        $r = wp_parse_args( (array) $args, array(
            'id'                => '',
            'position'          => 99,
            'component'         => '',
            'must_be_logged_in' => true,
            'block_self'        => false,
            'parent_element'    => false,
            'parent_attr'       => array(),
            'button_element'    => 'a',
            'button_attr'       => array(),
            'link_text'         => '',
        ) );
 
        // Just don't set the button if a param is missing
        if ( empty( $r['id'] ) || empty( $r['component'] ) || empty( $r['link_text'] ) ) {
            return false;
        }
 
        $r['id'] = sanitize_key( $r['id'] );
 
        // If the button already exist don't add it
        if ( isset( $this->group[ $r['id'] ] ) ) {
            return false;
        }
 
        /*
         * If, in bp_nouveau_get_*_buttons(), we pass through a false value for 'parent_element'
         * but we have attributtes for it in the array, let's default to setting a div.
         *
         * Otherwise, the original false value will be passed through to BP buttons.
         * @todo: this needs review, probably trying to be too clever
         */
        if ( ( ! empty( $r['parent_attr'] ) ) && false === $r['parent_element'] ) {
            $r['parent_element'] = 'div';
        }
 
        $this->group[ $r['id'] ] = $r;
 
    }
 
 
    /**
     * Sort the Buttons of the group according to their position attribute
     *
     * @since BuddyPress 3.0.0
     *
     * @param array the list of buttons to sort.
     *
     * @return array the list of buttons sorted.
     */
    public function sort( $buttons ) {
        $sorted = array();
 
        foreach ( $buttons as $button ) {
            $position = 99;
 
            if ( isset( $button['position'] ) ) {
                $position = (int) $button['position'];
            }
 
            // If position is already taken, move to the first next available
            if ( isset( $sorted[ $position ] ) ) {
                $sorted_keys = array_keys( $sorted );
 
                do {
                    $position += 1;
                } while ( in_array( $position, $sorted_keys, true ) );
            }
 
            $sorted[ $position ] = $button;
        }
 
        ksort( $sorted );
        return $sorted;
    }
 
    /**
     * Get the BuddyPress buttons for the group
     *
     * @since BuddyPress 3.0.0
     *
     * @param bool $sort whether to sort the buttons or not.
     *
     * @return array An array of HTML links.
     */
    public function get( $sort = true ) {
        $buttons = array();
 
        if ( empty( $this->group ) ) {
            return $buttons;
        }
 
        if ( true === $sort ) {
            $this->group = $this->sort( $this->group );
        }
 
        foreach ( $this->group as $key_button => $button ) {
            // Reindex with ids.
            if ( true === $sort ) {
                $this->group[ $button['id'] ] = $button;
                unset( $this->group[ $key_button ] );
            }
 
            $buttons[ $button['id'] ] = bp_get_button( $button );
        }
 
        return $buttons;
    }
 
    /**
     * Update the group of buttons
     *
     * @since BuddyPress 3.0.0
     *
     * @param array $args Optional. See the __constructor for a description of this argument.
     */
    public function update( $args = array() ) {
        $this->group = array();
        foreach ( $args as $id => $params ) {
            $this->set( $params );
        }
    }
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
BuddyPress 3.0.0 Introduced.

Methods

  • __construct — Constructor
  • get — Get the BuddyPress buttons for the group
  • set — Set the button
  • sort — Sort the Buttons of the group according to their position attribute
  • update — Update the group of buttons

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.