Contents

Code Reference Functions bbp_format_buddypress_notifications()

bbp_format_buddypress_notifications( string $action, int $item_id, int $secondary_item_id, int $total_items, string $format = 'string' )

Format the BuddyBar/Toolbar notifications

Description

Parameters

$action

(Required) The kind of notification being rendered

$item_id

(Required) The primary item id

$secondary_item_id

(Required) The secondary item id

$total_items

(Required) The total number of messaging-related notifications waiting for the user

$format

(Optional) 'string' for BuddyBar-compatible notifications; 'array' for WP Toolbar

Default value: 'string'

Source

File: bp-forums/notifications.php

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
function bbp_format_buddypress_notifications( $action, $item_id, $secondary_item_id, $total_items, $format = 'string' ) {
 
    // New reply notifications
    if ( 'bbp_new_reply' === $action ) {
        $topic_id    = bbp_get_reply_topic_id( $item_id );
        $topic_title = bbp_get_topic_title( $topic_id );
        $topic_link  = wp_nonce_url( add_query_arg( array( 'action' => 'bbp_mark_read', 'topic_id' => $topic_id ), bbp_get_reply_url( $item_id ) ), 'bbp_mark_topic_' . $topic_id );
        $title_attr  = __( 'Discussion Replies', 'buddyboss' );
 
        if ( (int) $total_items > 1 ) {
            $text   = sprintf( __( 'You have %d new replies', 'buddyboss' ), (int) $total_items );
            $filter = 'bbp_multiple_new_subscription_notification';
        } else {
            if ( !empty( $secondary_item_id ) ) {
                $text = sprintf( __( 'You have %d new reply to %2$s from %3$s', 'buddyboss' ), (int) $total_items, $topic_title, bp_core_get_user_displayname( $secondary_item_id ) );
            } else {
                $text = sprintf( __( 'You have %d new reply to %s',             'buddyboss' ), (int) $total_items, $topic_title );
            }
            $filter = 'bbp_single_new_subscription_notification';
        }
 
        // WordPress Toolbar
        if ( 'string' === $format ) {
            $return = apply_filters( $filter, '<a href="' . esc_url( $topic_link ) . '" title="' . esc_attr( $title_attr ) . '">' . esc_html( $text ) . '</a>', (int) $total_items, $text, $topic_link );
 
        // Deprecated BuddyBar
        } else {
            $return = apply_filters( $filter, array(
                'text' => $text,
                'link' => $topic_link
            ), $topic_link, (int) $total_items, $text, $topic_title );
        }
 
        /**
         * @todo add title/description
         *
         * @since BuddyBoss 1.0.0
         */
        do_action( 'bbp_format_buddypress_notifications', $action, $item_id, $secondary_item_id, $total_items );
 
        return $return;
    }
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
bbPress (r5155) Introduced.

Uses

Uses
Uses Description
bp-forums/topics/template.php: bbp_get_topic_title()

Return the title of the topic
bp-forums/replies/template.php: bbp_get_reply_topic_id()

Return the topic id a reply belongs to
bp-forums/replies/template.php: bbp_get_reply_url()

Return the paginated url to the reply in the reply loop
bp-groups/bp-groups-notifications.php: {$filter}

Filters single accepted group membership request notification for non-string format.
bp-members/bp-members-functions.php: bp_core_get_user_displayname()

Fetch the display name for a user.

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.