Contents

Code Reference Functions groups_notification_group_invites()

groups_notification_group_invites( BP_Groups_Group $group, BP_Groups_Member $member, int $inviter_user_id )

Notify a member they have been invited to a group.

Description

Parameters

$group

(Required) Group object.

$member

(Required) Member object.

$inviter_user_id

(Required) ID of the user who sent the invite.

Source

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

311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
function groups_notification_group_invites( &$group, &$member, $inviter_user_id ) {
 
    // Bail if member has already been invited.
    if ( ! empty( $member->invite_sent ) ) {
        return;
    }
 
    // @todo $inviter_ud may be used for caching, test without it
    $inviter_ud      = bp_core_get_core_userdata( $inviter_user_id );
    $invited_user_id = $member->user_id;
 
    // Trigger a BuddyPress Notification.
    if ( bp_is_active( 'notifications' ) ) {
        bp_notifications_add_notification( array(
            'user_id'          => $invited_user_id,
            'item_id'          => $group->id,
            'component_name'   => buddypress()->groups->id,
            'component_action' => 'group_invite',
        ) );
    }
 
    // Bail if member opted out of receiving this email.
    if ( 'no' === bp_get_user_meta( $invited_user_id, 'notification_groups_invite', true ) ) {
        return;
    }
 
    $invited_link = bp_core_get_user_domain( $invited_user_id ) . bp_get_groups_slug();
 
    $unsubscribe_args = array(
        'user_id'           => $invited_user_id,
        'notification_type' => 'groups-invitation',
    );
 
    $args         = array(
        'tokens' => array(
            'group'           => $group,
            'group.url'       => bp_get_group_permalink( $group ),
            'group.name'      => $group->name,
            'inviter.name'    => bp_core_get_userlink( $inviter_user_id, true, false, true ),
            'inviter.url'     => bp_core_get_user_domain( $inviter_user_id ),
            'inviter.id'      => $inviter_user_id,
            'invites.url'     => esc_url( $invited_link . '/invites/' ),
            'invites.message' => bp_groups_get_invite_messsage_for_user( $invited_user_id, $group->id ),
            'unsubscribe'     => esc_url( bp_email_get_unsubscribe_link( $unsubscribe_args ) ),
        ),
    );
    bp_send_email( 'groups-invitation', (int) $invited_user_id, $args );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
BuddyPress 1.0.0 Introduced.

Uses

Uses
Uses Description
bp-groups/bp-groups-functions.php: groups_get_invites()

Get invitations to a given group filtered by arguments.
bp-loader.php: buddypress()

The main function responsible for returning the one true BuddyBoss Instance to functions everywhere.
bp-notifications/bp-notifications-functions.php: bp_notifications_add_notification()

Add a notification for a specific user, from a specific component.
bp-groups/bp-groups-template.php: bp_get_group_permalink()

Return the permalink for the current group in the loop.
bp-groups/bp-groups-template.php: bp_get_groups_slug()

Return the groups component slug.
bp-members/bp-members-functions.php: bp_core_get_userlink()

Return a HTML formatted link for a user with the user’s full name as the link text.
bp-members/bp-members-functions.php: bp_core_get_core_userdata()

Fetch everything in the wp_users table for a user, without any usermeta.
bp-members/bp-members-functions.php: bp_core_get_user_domain()

Return the domain for the passed user: e.g. http://example.com/members/andy/.
bp-core/bp-core-template.php: bp_is_active()

Check whether a given component (or feature of a component) is active.
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 7 more uses Hide more uses
Used By
Used By Description
bp-groups/classes/class-bp-groups-invitation-manager.php: BP_Groups_Invitation_Manager::run_send_action()

This is where custom actions are added to run when notifications of an invitation or request need to be generated & sent.

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.