Contents

Code Reference Functions bbp_get_component_name()

bbp_get_component_name()

Return Forums’ component name/ID (‘forums’ by default)

Description

This is used primarily for Notifications integration.

Return

(string)

Source

File: bp-forums/functions.php

23
24
25
26
27
28
29
30
31
32
33
34
35
function bbp_get_component_name() {
 
    // Use existing ID
    if ( !empty( bbpress()->extend->buddypress->id ) ) {
        $retval = bbpress()->extend->buddypress->id;
 
    // Use default
    } else {
        $retval = 'forums';
    }
 
    return apply_filters( 'bbp_get_component_name', $retval );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
bbPress (r5232) Introduced.

Uses

Uses
Uses Description
bp-forums/classes/class-bbpress.php: bbpress()

The main function responsible for returning the one true bbPress Instance to functions everywhere.
Used By
Used By Description
bp-forums/notifications.php: bbp_buddypress_add_topic_notification()

Hooked into the new topic function, this notification action is responsible for notifying topic.
bp-forums/notifications.php: bbp_filter_notifications_get_registered_components()

Filter registered notifications components, and add ‘forums’ to the queried ‘component_name’ array.
bp-forums/notifications.php: bbp_buddypress_add_notification()

Hooked into the new reply function, this notification action is responsible for notifying topic and hierarchical reply authors of topic replies.
bp-forums/notifications.php: bbp_buddypress_mark_notifications()

Mark notifications as read when reading a topic

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.