Contents

Code Reference Classes BP_Forums_Component

BP_Forums_Component

Loads Forums Component

Description

Source

File: bp-forums/classes/class-bp-forums-component.php

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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
class BP_Forums_Component extends BP_Component {
 
    /**
     * Start the forums component creation process
     *
     * @since bbPress (r3552)
     */
    public function __construct() {
        parent::start(
            'forums',
            __( 'Forums', 'buddyboss' ),
            buddypress()->plugin_dir
        );
        // $this->includes();
        // $this->setup_globals();
        // $this->setup_actions();
        // $this->fully_loaded();
    }
 
    /**
     * Include BuddyBoss classes and functions
     */
    public function includes( $includes = array() ) {
        $includes = $includes ?: [];
 
        // Helper BuddyBoss functions
        $includes[] = 'admin.php';
 
        // Helper BuddyBoss functions
        $includes[] = 'functions.php';
 
        // Members modifications
        $includes[] = 'members.php';
 
        // BuddyBoss Notfications Extension functions
        if ( bp_is_active( 'notifications' ) ) {
            $includes[] = 'notifications.php';
        }
 
        // BuddyBoss Activity Extension class
        if ( bp_is_active( 'activity' ) ) {
            $includes[] = 'activity.php';
        }
 
        // BuddyBoss Group Extension class
        if ( bp_is_active( 'groups' ) ) {
            $includes[] = 'groups.php';
        }
 
        parent::includes( $includes );
    }
 
    /**
     * Setup globals
     *
     * The BP_FORUMS_SLUG constant is deprecated, and only used here for
     * backwards compatibility.
     *
     * @since bbPress (r3552)
     */
    public function setup_globals( $args = array() ) {
        $bp = buddypress();
 
        // Define the parent forum ID
        if ( !defined( 'BP_FORUMS_PARENT_FORUM_ID' ) )
            define( 'BP_FORUMS_PARENT_FORUM_ID', 1 );
 
        // Define a slug, if necessary
        if ( !defined( 'BP_FORUMS_SLUG' ) )
            define( 'BP_FORUMS_SLUG', $this->id );
 
        // All arguments for forums component
        $args = array(
            'path'          => BP_PLUGIN_DIR,
            'slug'          => bp_get_option( '_bbp_root_slug', BP_FORUMS_SLUG ),
            'root_slug'     => isset( $bp->pages->forums->slug ) ? $bp->pages->forums->slug : BP_FORUMS_SLUG,
            'has_directory' => false,
            'search_string' => __( 'Search Forums…', 'buddyboss' ),
        );
 
        parent::setup_globals( $args );
    }
 
    /**
     * Setup the actions
     *
     * @since bbPress (r3395)
     * @access private
     * @uses add_filter() To add various filters
     * @uses add_action() To add various actions
     * @link http://bbpress.trac.wordpress.org/ticket/2176
     */
    public function setup_actions() {
 
        // Setup the components
        add_action( 'bp_init', array( $this, 'setup_components' ), 7 );
 
        parent::setup_actions();
    }
 
    /**
     * Instantiate classes for BuddyBoss integration
     *
     * @since bbPress (r3395)
     */
    public function setup_components() {
 
        // Always load the members component
        bbpress()->extend->buddypress->members = new BBP_BuddyPress_Members;
 
        // Create new activity class
        if ( bp_is_active( 'activity' ) ) {
            bbpress()->extend->buddypress->activity = new BBP_BuddyPress_Activity;
        }
 
        // Register the group extension only if groups are active
        if ( bbp_is_group_forums_active() && bp_is_active( 'groups' ) ) {
            bp_register_group_extension( 'BBP_Forums_Group_Extension' );
        }
    }
 
    /**
     * Allow the variables, actions, and filters to be modified by third party
     * plugins and themes.
     *
     * @since bbPress (r3902)
     */
    private function fully_loaded() {
        do_action_ref_array( 'bbp_buddypress_loaded', array( $this ) );
    }
 
    /**
     * Setup BuddyBar navigation
     *
     * @since bbPress (r3552)
     */
    public function setup_nav( $main_nav = array(), $sub_nav = array() ) {
 
        // Stop if there is no user displayed or logged in
        if ( !is_user_logged_in() && !bp_displayed_user_id() )
            return;
 
        // Define local variable(s)
        $user_domain = '';
 
        // Add 'Forums' to the main navigation
        $main_nav = array(
            'name'                => __( 'Forums', 'buddyboss' ),
            'slug'                => $this->slug,
            'position'            => 80,
            'screen_function'     => 'bbp_member_forums_screen_topics',
            'default_subnav_slug' => bbp_get_topic_archive_slug(),
            'item_css_id'         => $this->id
        );
 
        // Determine user to use
        if ( bp_displayed_user_id() )
            $user_domain = bp_displayed_user_domain();
        elseif ( bp_loggedin_user_domain() )
            $user_domain = bp_loggedin_user_domain();
        else
            return;
 
        // User link
        $forums_link = trailingslashit( $user_domain . $this->slug );
 
        // Topics started
        $sub_nav[] = array(
            'name'            => __( 'My Discussions', 'buddyboss' ),
            'slug'            => bbp_get_topic_archive_slug(),
            'parent_url'      => $forums_link,
            'parent_slug'     => $this->slug,
            'screen_function' => 'bbp_member_forums_screen_topics',
            'position'        => 20,
            'item_css_id'     => 'topics'
        );
 
        // Replies to topics
        $sub_nav[] = array(
            'name'            => __( 'My Replies', 'buddyboss' ),
            'slug'            => bbp_get_reply_archive_slug(),
            'parent_url'      => $forums_link,
            'parent_slug'     => $this->slug,
            'screen_function' => 'bbp_member_forums_screen_replies',
            'position'        => 40,
            'item_css_id'     => 'replies'
        );
 
        // Favorite topics
        $sub_nav[] = array(
            'name'            => __( 'My Favorites', 'buddyboss' ),
            'slug'            => bbp_get_user_favorites_slug(),
            'parent_url'      => $forums_link,
            'parent_slug'     => $this->slug,
            'screen_function' => 'bbp_member_forums_screen_favorites',
            'position'        => 60,
            'item_css_id'     => 'favorites'
        );
 
        // Subscribed topics (my profile only)
        if ( bp_is_my_profile() ) {
            $sub_nav[] = array(
                'name'            => __( 'Subscriptions', 'buddyboss' ),
                'slug'            => bbp_get_user_subscriptions_slug(),
                'parent_url'      => $forums_link,
                'parent_slug'     => $this->slug,
                'screen_function' => 'bbp_member_forums_screen_subscriptions',
                'position'        => 60,
                'item_css_id'     => 'subscriptions'
            );
        }
 
        parent::setup_nav( $main_nav, $sub_nav );
    }
 
    /**
     * Set up the admin bar
     *
     * @since bbPress (r3552)
     */
    public function setup_admin_bar( $wp_admin_nav = array() ) {
 
        // Menus for logged in user
        if ( is_user_logged_in() ) {
 
            // Setup the logged in user variables
            $user_domain = bp_loggedin_user_domain();
            $forums_link = trailingslashit( $user_domain . $this->slug );
 
            // Add the "My Account" sub menus
            $wp_admin_nav[] = array(
                'parent' => buddypress()->my_account_menu_id,
                'id'     => 'my-account-' . $this->id,
                'title'  => __( 'Forums', 'buddyboss' ),
                'href'   => trailingslashit( $forums_link )
            );
 
            // Topics
            $wp_admin_nav[] = array(
                'parent' => 'my-account-' . $this->id,
                'id'     => 'my-account-' . $this->id . '-topics',
                'title'  => __( 'My Discussions', 'buddyboss' ),
                'href'   => trailingslashit( $forums_link . bbp_get_topic_archive_slug() )
            );
 
            // Replies
            $wp_admin_nav[] = array(
                'parent' => 'my-account-' . $this->id,
                'id'     => 'my-account-' . $this->id . '-replies',
                'title'  => __( 'My Replies', 'buddyboss' ),
                'href'   => trailingslashit( $forums_link . bbp_get_reply_archive_slug() )
            );
 
            // Favorites
            $wp_admin_nav[] = array(
                'parent' => 'my-account-' . $this->id,
                'id'     => 'my-account-' . $this->id . '-favorites',
                'title'  => __( 'My Favorites', 'buddyboss' ),
                'href'   => trailingslashit( $forums_link . bbp_get_user_favorites_slug() )
            );
 
            // Subscriptions
            $wp_admin_nav[] = array(
                'parent' => 'my-account-' . $this->id,
                'id'     => 'my-account-' . $this->id . '-subscriptions',
                'title'  => __( 'Subscriptions', 'buddyboss' ),
                'href'   => trailingslashit( $forums_link . bbp_get_user_subscriptions_slug() )
            );
        }
 
        parent::setup_admin_bar( $wp_admin_nav );
    }
 
    /**
     * Sets up the title for pages and <title>
     *
     * @since bbPress (r3552)
     */
    public function setup_title() {
        $bp = buddypress();
 
        // Adjust title based on view
        if ( bp_is_forums_component() ) {
            if ( bp_is_my_profile() ) {
                $bp->bp_options_title = __( 'Forums', 'buddyboss' );
            } elseif ( bp_is_user() ) {
                $bp->bp_options_avatar = bp_core_fetch_avatar( array(
                    'item_id' => bp_displayed_user_id(),
                    'type'    => 'thumb'
                ) );
                $bp->bp_options_title = bp_get_displayed_user_fullname();
            }
        }
 
        parent::setup_title();
    }
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
bbPress (r3552) Introduced.

Uses

Uses
Uses Description
bp-core/classes/class-bp-component.php: BP_Component

BuddyPress Component Class.

Methods

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.