bp_activity_user_can_read( BP_Activity_Activity $activity, integer $user_id )

Can a user see a particular activity item?

Description

Parameters

$activity: (Required) Activity object.
$user_id: (Required) User ID.

Return

(boolean) True on success, false on failure.

Source

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

function bp_activity_user_can_read( $activity, $user_id = 0 ) {
    $retval = true;
 
    // Fallback.
    if ( empty( $user_id ) ) {
        $user_id = bp_loggedin_user_id();
    }
 
    // If activity is from a group, do extra cap checks.
    if ( bp_is_active( 'groups' ) && buddypress()->groups->id === $activity->component ) {
        // Check to see if the user has access to the activity's parent group.
        $group = groups_get_group( $activity->item_id );
        if ( $group ) {
            // For logged-in user, we can check against the 'user_has_access' prop.
            if ( bp_loggedin_user_id() === $user_id ) {
                $retval = $group->user_has_access;
 
            // Manually check status.
            } elseif ( 'private' === $group->status || 'hidden' === $group->status ) {
                // Only group members that are not banned can view.
                if ( ! groups_is_user_member( $user_id, $activity->item_id ) || groups_is_user_banned( $user_id, $activity->item_id ) ) {
                    $retval = false;
                }
            }
        }
    }
 
    // Spammed items are not visible to the public.
    if ( $activity->is_spam ) {
        $retval = false;
    }
 
    // Site moderators can view anything.
    if ( bp_current_user_can( 'bp_moderate' ) ) {
        $retval = true;
    }
 
    /**
     * Filters whether the current user has access to an activity item.
     *
     * @since BuddyPress 3.0.0
     *
     * @param bool                 $retval   Return value.
     * @param int                  $user_id  Current user ID.
     * @param BP_Activity_Activity $activity Activity object.
     */
    return apply_filters( 'bp_activity_user_can_read', $retval, $user_id, $activity );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 3.0.0	Introduced.

Uses

Uses
Uses	Description
bp-loader.php: buddypress()	The main function responsible for returning the one true BuddyBoss Instance to functions everywhere.
bp-groups/bp-groups-functions.php: groups_is_user_banned()	Check whether a user is banned from a given group.
bp-groups/bp-groups-functions.php: groups_is_user_member()	Check whether a user is a member of a given group.
bp-groups/bp-groups-functions.php: groups_get_group()	Fetch a single group object.
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-caps.php: bp_current_user_can()	Check whether the current user has a given capability.
bp-activity/bp-activity-functions.php: bp_activity_user_can_read	Filters whether the current user has access to an activity item.

Show 3 more uses Hide more uses

Used By
Used By	Description
bp-activity/classes/class-bp-rest-activity-endpoint.php: BP_REST_Activity_Endpoint::can_see()	Can this user see the activity?
bp-activity/screens/permalink.php: bp_activity_screen_single_activity_permalink()	Load the page for a single activity item.

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.

Contents