bp_user_can( int $user_id, string $capability, array|int $args = array() )

Check whether the specified user has a given capability on a given site.

Description

Parameters

$user_id

(Required)

$capability

(Required) Capability or role name.

$args

(Optional) Array of extra arguments applicable to the capability check.

'site_id'
(int) Optional. Site ID. Defaults to the BP root blog.
'a,...'
(mixed) Optional. Extra arguments applicable to the capability check.

Default value: array()

Return

(bool) True if the user has the cap for the given parameters.

Source

File: bp-core/bp-core-caps.php

function bp_user_can( $user_id, $capability, $args = array() ) {
    $site_id = bp_get_root_blog_id();
 
    // Get the site ID if set, but don't pass along to user_can().
    if ( isset( $args['site_id'] ) ) {
        $site_id = (int) $args['site_id'];
        unset( $args['site_id'] );
    }
 
    $switched = is_multisite() ? switch_to_blog( $site_id ) : false;
    $retval   = call_user_func_array( 'user_can', array( $user_id, $capability, $args ) );
 
    /**
     * Filters whether or not the specified user has a given capability on a given site.
     *
     * @since BuddyPress 2.7.0
     *
     * @param bool   $retval     Whether or not the current user has the capability.
     * @param int    $user_id
     * @param string $capability The capability being checked for.
     * @param int    $site_id    Site ID. Defaults to the BP root blog.
     * @param array  $args       Array of extra arguments passed.
     */
    $retval = (bool) apply_filters( 'bp_user_can', $retval, $user_id, $capability, $site_id, $args );
 
    if ( $switched ) {
        restore_current_blog();
    }
 
    return $retval;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 2.7.0	Introduced.

Uses

Uses
Uses	Description
bp-core/bp-core-wpabstraction.php: switch_to_blog()	Switch to specified blog.
bp-core/bp-core-wpabstraction.php: restore_current_blog()	Restore current blog.
bp-core/bp-core-caps.php: bp_user_can	Filters whether or not the specified user has a given capability on a given site.
bp-core/bp-core-functions.php: bp_get_root_blog_id()	Get the ID of the root blog.

Used By
Used By	Description
bp-messages/classes/class-bp-rest-messages-endpoint.php: BP_REST_Messages_Endpoint::get_current_user_permissions()	Get current user’s permission.
bp-groups/bp-groups-filters.php: bp_groups_disable_at_mention_forums_notification_for_non_public_groups()	Disable at-mention forum notifications for users who are not a member of the non-public group.
bp-groups/classes/class-bp-rest-groups-endpoint.php: BP_REST_Groups_Endpoint::bp_rest_get_sub_groups()	Get sub groups id.
bp-groups/classes/class-bp-groups-invitation-manager.php: BP_Groups_Invitation_Manager::allow_invitation()	Should this invitation be created?
bp-groups/classes/class-bp-groups-invitation-manager.php: BP_Groups_Invitation_Manager::allow_request()	Should this request be created?
bp-groups/bp-groups-template.php: bp_get_parent_group_id()	Get the parent group ID for a specific group.
bp-groups/bp-groups-template.php: bp_get_descendent_groups()	Get all groups that are descendants of a specific group.
bp-groups/bp-groups-template.php: bp_groups_user_can_send_invites()	Can a user send invitations in the specified group?
bp-groups/bp-groups-filters.php: bp_groups_disable_at_mention_notification_for_non_public_groups()	Disable at-mention notifications for users who are not a member of the non-public group where the activity appears.
bp-groups/bp-groups-filters.php: bp_groups_user_can_filter()	Filter the bp_user_can value to determine what the user can do with regards to a specific group.
bp-core/bp-core-caps.php: bp_current_user_can()	Check whether the current user has a given capability.

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.

Contents