Contents

Code Reference Functions groups_record_activity()

groups_record_activity( array|string $args = '' )

Record an activity item related to the Groups component.

Description

A wrapper for bp_activity_add() that provides some Groups-specific defaults.

See also

Parameters

$args

(Optional) An array of arguments for the new activity item. Accepts all parameters of bp_activity_add(). However, this wrapper provides some additional defaults, as described below:

  • 'component'
    (string) Default: the id of your Groups component (usually 'groups').
  • 'hide_sitewide'
    (bool) Default: True if the current group is not public, otherwise false.

Default value: ''

Return

(WP_Error|bool|int) See bp_activity_add().

Source

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

442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
function groups_record_activity( $args = '' ) {
 
    if ( ! bp_is_active( 'activity' ) ) {
        return false;
    }
 
    // Set the default for hide_sitewide by checking the status of the group.
    $hide_sitewide = false;
    if ( !empty( $args['item_id'] ) ) {
        if ( bp_get_current_group_id() == $args['item_id'] ) {
            $group = groups_get_current_group();
        } else {
            $group = groups_get_group( $args['item_id'] );
        }
 
        if ( isset( $group->status ) && 'public' != $group->status ) {
            $hide_sitewide = true;
        }
    }
 
    $r = bp_parse_args( $args, array(
        'id'                => false,
        'user_id'           => bp_loggedin_user_id(),
        'action'            => '',
        'content'           => '',
        'primary_link'      => '',
        'component'         => buddypress()->groups->id,
        'type'              => false,
        'item_id'           => false,
        'secondary_item_id' => false,
        'recorded_time'     => bp_core_current_time(),
        'hide_sitewide'     => $hide_sitewide,
        'privacy'           => 'public',
        'error_type'        => 'bool'
    ), 'groups_record_activity' );
 
    return bp_activity_add( $r );
}

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-activity.php: bp_groups_get_activity_group()

Get the group object the activity belongs to.
bp-activity/bp-activity-template.php: bp_activity_user_can_edit()

Determine if the current user can edit an activity item.
bp-loader.php: buddypress()

The main function responsible for returning the one true BuddyBoss Instance to functions everywhere.
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-template.php: bp_loggedin_user_id()

Get the ID of the currently logged-in user.
bp-core/bp-core-functions.php: bp_core_current_time()

Get the current GMT time to save into the DB.
bp-core/bp-core-functions.php: bp_parse_args()

Merge user defined arguments into defaults array.
bp-activity/bp-activity-functions.php: bp_activity_add()

Add an activity item.
bp-activity/bp-activity-functions.php: bp_activity_update_meta()

Update a piece of activity meta.
bp-activity/classes/class-bp-activity-activity.php: BP_Activity_Activity::__construct()

Constructor method.
Show 5 more uses Hide more uses
Used By
Used By Description
bp-activity/bp-activity-filters.php: bp_activity_edit_update_media()

Update media and activity for media updation and deletion while editing the activity.
bp-activity/bp-activity-filters.php: bp_activity_edit_update_document()

Update document and activity for document updation and deletion while editing the activity.
bp-activity/bp-activity-filters.php: bp_activity_media_add()

Create media activity for each media uploaded
bp-activity/bp-activity-filters.php: bp_activity_document_add()

Create document activity for each document uploaded
bp-groups/screens/user/invites.php: groups_screen_group_invites()

Handle the loading of a user’s Groups > Invites page.
bp-groups/actions/create.php: groups_action_create_group()

Catch and process group creation form submissions.
bp-groups/bp-groups-functions.php: groups_post_update()

Post an Activity status update affiliated with a group.
bp-groups/bp-groups-functions.php: groups_join_group()

Add a user to a group.
bp-groups/bp-groups-activity.php: bp_groups_group_details_updated_add_activity()

Add an activity item when a group’s details are updated.
bp-groups/bp-groups-activity.php: bp_groups_membership_accepted_add_activity()

Add an activity feed item when a member joins a group.
bp-templates/bp-nouveau/includes/groups/ajax.php: bp_nouveau_ajax_joinleave_group()

Join or leave a group when clicking the “join/leave” button via a POST request.
Show 6 more used by Hide more used by

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.