Contents

Code Reference Functions groups_notification_group_updated()

groups_notification_group_updated( int $group_id, BP_Groups_Group|null $old_group = null )

Notify all group members when a group is updated.

Description

Parameters

$group_id

(Required) ID of the group.

$old_group

(Optional) Group before new details were saved.

Default value: null

Source

File: bp-groups/bp-groups-notifications.php

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
function groups_notification_group_updated( $group_id = 0, $old_group = null ) {
    $group = groups_get_group( $group_id );
 
    if ( $old_group instanceof BP_Groups_Group ) {
        $changed = array();
 
        if ( $group->name !== $old_group->name ) {
            $changed[] = sprintf(
                __( '* Name changed from "%s" to "%s".', 'buddyboss' ),
                esc_html( $old_group->name ),
                esc_html( $group->name )
            );
        }
 
        if ( $group->description !== $old_group->description ) {
            $changed[] = sprintf(
                __( '* Description changed from "%s" to "%s".', 'buddyboss' ),
                esc_html( $old_group->description ),
                esc_html( $group->description )
            );
        }
 
        if ( $group->slug !== $old_group->slug ) {
            $changed[] = sprintf(
                __( '* Permalink changed from "%s" to "%s".', 'buddyboss' ),
                esc_url( bp_get_group_permalink( $old_group ) ),
                esc_url( bp_get_group_permalink( $group ) )
            );
        }
    }
 
    /**
     * Filters the bullet points listing updated items in the email notification after a group is updated.
     *
     * @since BuddyPress 2.2.0
     *
     * @param array $changed Array of bullet points.
     */
    $changed = apply_filters( 'groups_notification_group_update_updated_items', $changed );
 
    $changed_text = '';
    if ( ! empty( $changed ) ) {
        $changed_text = implode( "\n", $changed );
    }
 
    $user_ids = BP_Groups_Member::get_group_member_ids( $group->id );
    foreach ( (array) $user_ids as $user_id ) {
 
        // Continue if member opted out of receiving this email.
        if ( 'no' === bp_get_user_meta( $user_id, 'notification_groups_group_updated', true ) ) {
            continue;
        }
 
        $unsubscribe_args = array(
            'user_id'           => $user_id,
            'notification_type' => 'groups-details-updated',
        );
 
        $args = array(
            'tokens' => array(
                'changed_text' => $changed_text,
                'group'        => $group,
                'group.id'     => $group_id,
                'group.url'    => esc_url( bp_get_group_permalink( $group ) ),
                'group.name'   => $group->name,
                'unsubscribe'  => esc_url( bp_email_get_unsubscribe_link( $unsubscribe_args ) ),
            ),
        );
        bp_send_email( 'groups-details-updated', (int) $user_id, $args );
    }
 
    /**
     * Fires after the notification is sent that a group has been updated.
     *
     * See https://buddypress.trac.wordpress.org/ticket/3644 for blank message parameter.
     *
     * @since BuddyPress 1.5.0
     * @since BuddyPress 2.5.0 $subject has been unset and is deprecated.
     *
     * @param array  $user_ids Array of user IDs to notify about the update.
     * @param string $subject  Deprecated in 2.5; now an empty string.
     * @param string $value    Empty string preventing PHP error.
     * @param int    $group_id ID of the group that was updated.
     */
    do_action( 'bp_groups_sent_updated_email', $user_ids, '', '', $group_id );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
BuddyPress 1.0.0 Introduced.

Uses

Uses
Uses Description
bp-groups/classes/class-bp-groups-member.php: BP_Groups_Member::get_group_member_ids()

Get the IDs of all a given group’s members.
bp-groups/bp-groups-functions.php: groups_get_group()

Fetch a single group object.
bp-groups/bp-groups-template.php: bp_get_group_permalink()

Return the permalink for the current group in the loop.
bp-groups/bp-groups-notifications.php: groups_notification_group_update_updated_items

Filters the bullet points listing updated items in the email notification after a group is updated.
bp-groups/bp-groups-notifications.php: bp_groups_sent_updated_email

Fires after the notification is sent that a group has been updated.
bp-core/bp-core-functions.php: bp_email_get_unsubscribe_link()

Creates unsubscribe link for notification emails.
bp-core/bp-core-functions.php: bp_send_email()

Send email, similar to WordPress’ wp_mail().
bp-core/bp-core-functions.php: bp_get_user_meta()

Get a piece of usermeta.
Show 3 more uses Hide more uses

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.