# bbpress/2.6.17/includes/users/capabilities.php bbPress, version 2.6.17. 957 lines. - Page: https://pluginprobe.com/plugins/bbpress/2.6.17/code/includes/users/capabilities.php - Raw: https://pluginprobe.com/plugins/bbpress/2.6.17/raw/includes/users/capabilities.php - Modified: 2026-09-16T07:00:16+00:00 Line numbers below start at 1. Link to a line or a range by appending a fragment to the page URL, for example `https://pluginprobe.com/plugins/bbpress/2.6.17/code/includes/users/capabilities.php#L10-L20`. ```php post_type ) { // Forum. case bbp_get_forum_post_type() : $forum_id = bbp_get_forum_id( $_post->ID ); break; // Topic. case bbp_get_topic_post_type() : $forum_id = bbp_get_topic_forum_id( $_post->ID ); break; // Reply. case bbp_get_reply_post_type() : $forum_id = bbp_get_reply_forum_id( $_post->ID ); break; // Any other post type defaults to 0. default : $forum_id = 0; break; } // Bail if no forum ID. if ( empty( $forum_id ) ) { break; } // User is mod of this forum if ( bbp_is_object_of_user( $forum_id, $user_id, '_bbp_moderator_id' ) ) { $caps = array( 'spectate' ); } } break; /** Super Moderators **************************************************/ case 'edit_user' : case 'promote_user' : // Moderators can edit users if super moderators is enabled. if ( bbp_allow_super_mods() && ! is_admin() && bbp_is_single_user_edit() ) { // Get the user ID $_user_id = ! empty( $args[0] ) ? (int) $args[0] : bbp_get_displayed_user_id(); // Users can always edit themselves, so only map for others. if ( ! empty( $_user_id ) && ( $_user_id !== $user_id ) ) { // Super moderators cannot edit keymasters or site administrators. if ( ! bbp_is_user_keymaster( $_user_id ) && ! user_can( $_user_id, 'manage_options' ) && ! is_super_admin( $_user_id ) ) { $caps = array( 'moderate' ); } } } break; } // Filter & return return (array) apply_filters( 'bbp_map_primary_meta_caps', $caps, $cap, $user_id, $args ); } /** * Set a user's role in the forums * * @since 2.1.0 bbPress (r3860) * * @param int $user_id * * @return mixed False if no change. String of new role if changed. */ function bbp_set_user_role( $user_id = 0, $new_role = '' ) { // Validate user id $user_id = bbp_get_user_id( $user_id, false, false ); $user = get_userdata( $user_id ); // User exists if ( ! empty( $user ) ) { // Get user forum role $role = bbp_get_user_role( $user_id ); // User already has this role so no new role is set if ( $new_role === $role ) { $new_role = false; // User role is different than the new (valid) role } elseif ( bbp_is_valid_role( $new_role ) ) { // Remove the old role if ( ! empty( $role ) ) { $user->remove_role( $role ); } // Add the new role if ( ! empty( $new_role ) ) { $user->add_role( $new_role ); } } // User does not exist so return false } else { $new_role = false; } // Filter & return return apply_filters( 'bbp_set_user_role', $new_role, $user_id, $user ); } /** * Return a user's forums role * * @since 2.1.0 bbPress (r3860) * * @param int $user_id * * @return string */ function bbp_get_user_role( $user_id = 0 ) { // Validate user id $user_id = bbp_get_user_id( $user_id ); $user = get_userdata( $user_id ); $role = false; // User has roles so look for a bbPress one if ( ! empty( $user->roles ) ) { // Look for a bbPress role $roles = array_intersect( array_values( $user->roles ), array_keys( bbp_get_dynamic_roles() ) ); // If there's a role in the array, use the first one. This isn't very // smart, but since roles aren't exactly hierarchical, and bbPress // does not yet have a UI for multiple user roles, it's fine for now. if ( ! empty( $roles ) ) { $role = array_shift( $roles ); } } // Filter & return return apply_filters( 'bbp_get_user_role', $role, $user_id, $user ); } /** * Return a user's blog role * * @since 2.3.0 bbPress (r4446) * * @param int $user_id * * @return string */ function bbp_get_user_blog_role( $user_id = 0 ) { // Validate user id $user_id = bbp_get_user_id( $user_id ); $user = get_userdata( $user_id ); $role = false; // User has roles so lets if ( ! empty( $user->roles ) ) { // Look for a non bbPress role $roles = array_intersect( array_values( $user->roles ), array_keys( bbp_get_blog_roles() ) ); // If there's a role in the array, use the first one. This isn't very // smart, but since roles aren't exactly hierarchical, and WordPress // does not yet have a UI for multiple user roles, it's fine for now. if ( ! empty( $roles ) ) { $role = array_shift( $roles ); } } // Filter & return return apply_filters( 'bbp_get_user_blog_role', $role, $user_id, $user ); } /** * Helper function to save or update user roles and capabilities. * * By default, this is hooked to the `bbp_profile_update` action which fires * after a user profile is updated to avoid being stomped by set_role(). * * @since 2.2.0 bbPress (r4235) * * @param int $user_id * * @return void If no user ID passed, invalid request, trying to set own role, * current user cannot promote the passing user, or no role passed */ function bbp_profile_update_role( $user_id = 0 ) { // Bail if no user ID $user_id = bbp_get_user_id( $user_id, false, false ); if ( empty( $user_id ) ) { return; } // Bail if not a user profile form post request if ( ! bbp_is_user_profile_form_post_request( $user_id ) ) { return; } // Bail if trying to set their own role if ( bbp_is_user_home_edit() ) { return; } // Bail if the current user cannot edit the forum role. if ( ! bbp_current_user_can_edit_user_field( 'forum_role', $user_id ) ) { return; } // Bail if current user cannot promote the passing user if ( ! current_user_can( 'promote_user', $user_id ) ) { return; } // Bail if no role if ( ! isset( $_POST['bbp-forums-role'] ) || ! is_string( $_POST['bbp-forums-role'] ) ) { return; } // Forums role we want the user to have. $new_role = sanitize_key( wp_unslash( $_POST['bbp-forums-role'] ) ); // Bail if the current user cannot assign this forum role. if ( ! array_key_exists( $new_role, bbp_get_user_editable_forum_roles( $user_id ) ) ) { return; } // Set the new forums role bbp_set_user_role( $user_id, $new_role ); } /** * Return the forum roles the current user may assign to another user. * * @since 2.6.17 * * @param int $user_id User being edited. Defaults to the displayed user. * @return array Filtered array of editable forum roles. */ function bbp_get_user_editable_forum_roles( $user_id = 0 ) { $user_id = bbp_get_user_id( $user_id, false, false ); $roles = bbp_get_dynamic_roles(); // Moderators may assign non-staff roles by default. if ( ! bbp_is_user_keymaster() ) { unset( $roles[ bbp_get_keymaster_role() ], $roles[ bbp_get_moderator_role() ] ); } // Filter & return. return (array) apply_filters( 'bbp_get_user_editable_forum_roles', $roles, $user_id, bbp_get_current_user_id() ); } /** * Return whether the current user may edit a user-profile field. * * @since 2.6.17 * * @param string $field Profile field group: profile, email, password, * site_role, or forum_role. * @param int $user_id User being edited. Defaults to the displayed user. * @return bool Whether the field may be edited. */ function bbp_current_user_can_edit_user_field( $field = 'profile', $user_id = 0 ) { $user_id = bbp_get_user_id( $user_id, false, false ); $current_user_id = bbp_get_current_user_id(); // Default to the general profile-edit capability. $retval = current_user_can( 'edit_user', $user_id ); // Apply narrower defaults to sensitive field groups. switch ( $field ) { case 'password': $retval = ! empty( $user_id ) && ! empty( $current_user_id ) && $retval && ( ( $user_id === $current_user_id ) || bbp_is_user_keymaster( $current_user_id ) || current_user_can( 'manage_options' ) ); break; case 'site_role': $retval = current_user_can( 'promote_users' ) && current_user_can( 'promote_user', $user_id ); break; case 'forum_role': $retval = current_user_can( 'promote_user', $user_id ); break; } // Filter & return. return (bool) apply_filters( 'bbp_current_user_can_edit_user_field', $retval, $field, $user_id, $current_user_id ); } /** * Check if a role string is valid * * @since 2.6.5 * * @param string $role * * @return bool True if role is valid. False if role is not valid. */ function bbp_is_valid_role( $role = '' ) { // Default return value $retval = false; // Skip if no role to check if ( ! empty( $role ) && is_string( $role ) ) { // Get the dynamic role IDs $roles = array_keys( bbp_get_dynamic_roles() ); // Skip if no known role IDs if ( ! empty( $roles ) ) { // Is role in dynamic roles array? $retval = in_array( $role, $roles, true ); } } // Filter & return return (bool) apply_filters( 'bbp_is_valid_role', $retval, $role ); } /** * Add the default role to the current user if needed * * This function will bail if the forum is not global in a multisite * installation of WordPress, or if the user is marked as spam or deleted. * * @since 2.0.0 bbPress (r3380) * * @return void If not multisite, not global, or user is deleted/spammed */ function bbp_set_current_user_default_role() { /** Sanity ****************************************************************/ // Bail if deactivating bbPress if ( bbp_is_deactivation() ) { return; } // Catch all, to prevent premature user initialization if ( ! did_action( 'set_current_user' ) ) { return; } // Bail if not logged in or already a member of this site if ( ! is_user_logged_in() ) { return; } // Get the current user ID $user_id = bbp_get_current_user_id(); // Bail if user already has a forums role if ( bbp_get_user_role( $user_id ) ) { return; } // Bail if user is marked as spam or is deleted if ( bbp_is_user_inactive( $user_id ) ) { return; } /** Ready *****************************************************************/ // Load up bbPress once $bbp = bbpress(); // Get whether or not to add a role to the user account $add_to_site = bbp_allow_global_access(); // Get the current user's WordPress role. Set to empty string if none found. $user_role = bbp_get_user_blog_role( $user_id ); // Get the role map $role_map = bbp_get_user_role_map(); /** Forum Role ************************************************************/ // Use a mapped role or default role $new_role = empty( $user_role ) || ! isset( $role_map[ $user_role ] ) ? bbp_get_default_role() : $role_map[ $user_role ]; /** Add or Map ************************************************************/ // Add the user to the site if ( true === $add_to_site ) { bbp_set_user_role( $user_id, $new_role ); // Don't add the user, but still give them the correct caps dynamically } else { $bbp->current_user->caps[ $new_role ] = true; $bbp->current_user->get_role_caps(); } } /** * Return a map of WordPress roles to bbPress roles. Used to automatically grant * appropriate bbPress roles to WordPress users that wouldn't already have a * role in the forums. Also guarantees WordPress admins get the Keymaster role. * * @since 2.2.0 bbPress (r4334) * * @return array Filtered array of WordPress roles to bbPress roles */ function bbp_get_user_role_map() { // Get the default role once here $default_role = bbp_get_default_role(); // Filter & return return (array) apply_filters( 'bbp_get_user_role_map', array( 'administrator' => bbp_get_keymaster_role(), 'editor' => $default_role, 'author' => $default_role, 'contributor' => $default_role, 'subscriber' => $default_role ) ); } /** User Status ***************************************************************/ /** * Checks if the user has been marked as a spammer. * * @since 2.0.0 bbPress (r3355) * * @param int $user_id int The ID for the user. * @return bool True if spammer, False if not. */ function bbp_is_user_spammer( $user_id = 0 ) { // Default to current user if ( empty( $user_id ) && is_user_logged_in() ) { $user_id = bbp_get_current_user_id(); } // No user to check if ( empty( $user_id ) ) { return false; } // Assume user is not spam $is_spammer = false; // Get user data $user = get_userdata( $user_id ); // No user found if ( empty( $user ) ) { $is_spammer = false; // Check if spam } elseif ( ! empty( $user->spam ) ) { $is_spammer = true; } // Filter & return return (bool) apply_filters( 'bbp_core_is_user_spammer', $is_spammer ); } /** * Mark a users topics and replies as spam when the user is marked as spam * * @since 2.0.0 bbPress (r3405) * * @param int $user_id Optional. User ID to spam. Defaults to displayed user. * * @return bool If no user ID passed. */ function bbp_make_spam_user( $user_id = 0 ) { // Use displayed user if it's not yourself if ( empty( $user_id ) && bbp_is_single_user() && ! bbp_is_user_home() ) { $user_id = bbp_get_displayed_user_id(); } // Bail if no user ID if ( empty( $user_id ) ) { return false; } // Bail if user ID is keymaster if ( bbp_is_user_keymaster( $user_id ) ) { return false; } // Arm the torpedos $bbp_db = bbp_db(); // Get the blog IDs of the user to mark as spam $blogs = get_blogs_of_user( $user_id, true ); // If user has no blogs, they are a guest on this site if ( empty( $blogs ) ) { $blogs[ $bbp_db->blogid ] = array(); } // Process replies before topics so topic status helpers run last $post_types = array( bbp_get_reply_post_type(), bbp_get_topic_post_type() ); // Get array of statuses to mark as spam $post_statuses = bbp_get_public_topic_statuses(); $post_statuses = "'" . implode( "', '", $post_statuses ) . "'"; // Loop through blogs and remove their posts foreach ( (array) array_keys( $blogs ) as $blog_id ) { // Switch to the site ID bbp_switch_to_site( $blog_id ); foreach ( $post_types as $post_type ) { // Get posts of this type $query = $bbp_db->prepare( "SELECT ID FROM {$bbp_db->posts} WHERE post_author = %d AND post_status IN ( {$post_statuses} ) AND post_type = %s", $user_id, $post_type ); $posts = $bbp_db->get_col( $query ); // Loop through posts and spam them if ( ! empty( $posts ) ) { foreach ( $posts as $post_id ) { // The routines for topics and replies are different, so use the // correct one based on the post type switch ( $post_type ) { case bbp_get_topic_post_type() : bbp_spam_topic( $post_id ); break; case bbp_get_reply_post_type() : bbp_spam_reply( $post_id ); break; } } } } // Switch back to current site bbp_restore_current_site(); } // Delete user options bbp_delete_user_options( $user_id ); // Success return true; } /** * Mark a users topics and replies as spam when the user is marked as spam * * @since 2.0.0 bbPress (r3405) * * @param int $user_id Optional. User ID to unspam. Defaults to displayed user. * * @return bool If no user ID passed. */ function bbp_make_ham_user( $user_id = 0 ) { // Use displayed user if it's not yourself if ( empty( $user_id ) && bbp_is_single_user() && ! bbp_is_user_home() ) { $user_id = bbp_get_displayed_user_id(); } // Bail if no user ID if ( empty( $user_id ) ) { return false; } // Bail if user ID is keymaster if ( bbp_is_user_keymaster( $user_id ) ) { return false; } // Arm the torpedos $bbp_db = bbp_db(); // Get the blog IDs of the user to mark as spam $blogs = get_blogs_of_user( $user_id, true ); // If user has no blogs, they are a guest on this site if ( empty( $blogs ) ) { $blogs[ $bbp_db->blogid ] = array(); } // Process replies before topics so topic status helpers run last $post_types = array( bbp_get_reply_post_type(), bbp_get_topic_post_type() ); // Get array of statuses to unmark as spam $post_statuses = array( bbp_get_spam_status_id() ); $post_statuses = "'" . implode( "', '", $post_statuses ) . "'"; // Loop through blogs and remove their posts foreach ( (array) array_keys( $blogs ) as $blog_id ) { // Switch to the site ID bbp_switch_to_site( $blog_id ); foreach ( $post_types as $post_type ) { // Get posts of this type $query = $bbp_db->prepare( "SELECT ID FROM {$bbp_db->posts} WHERE post_author = %d AND post_status IN ( {$post_statuses} ) AND post_type = %s", $user_id, $post_type ); $posts = $bbp_db->get_col( $query ); // Loop through posts and unspam them if ( ! empty( $posts ) ) { foreach ( $posts as $post_id ) { // The routines for topics and replies are different, so use the // correct one based on the post type switch ( $post_type ) { case bbp_get_topic_post_type() : bbp_unspam_topic( $post_id ); break; case bbp_get_reply_post_type() : bbp_unspam_reply( $post_id ); break; } } } } // Switch back to current site bbp_restore_current_site(); } // Update topic & reply counts bbp_update_user_topic_count( $user_id, bbp_get_user_topic_count_raw( $user_id ) ); bbp_update_user_reply_count( $user_id, bbp_get_user_reply_count_raw( $user_id ) ); // Update last posted (to now) bbp_update_user_last_posted( $user_id ); // Success return true; } /** * Checks if the user has been marked as deleted. * * @since 2.0.0 bbPress (r3355) * * @param int $user_id int The ID for the user. * @return bool True if deleted, False if not. */ function bbp_is_user_deleted( $user_id = 0 ) { // Default to current user if ( empty( $user_id ) && is_user_logged_in() ) { $user_id = bbp_get_current_user_id(); } // No user to check if ( empty( $user_id ) ) { return false; } // Assume user is not deleted $is_deleted = false; // Get user data $user = get_userdata( $user_id ); // No user found if ( empty( $user ) ) { $is_deleted = true; // Check if deleted } elseif ( ! empty( $user->deleted ) ) { $is_deleted = true; } // Filter & return return (bool) apply_filters( 'bbp_core_is_user_deleted', $is_deleted ); } /** * Checks if user is active * * @since 2.0.0 bbPress (r3502) * * @param int $user_id The user ID to check * @return bool True if public, false if not */ function bbp_is_user_active( $user_id = 0 ) { // No user to check $user_id = bbp_get_user_id( $user_id, false, true ); if ( empty( $user_id ) ) { return false; } // Check spam if ( bbp_is_user_spammer( $user_id ) ) { return false; } // Check deleted if ( bbp_is_user_deleted( $user_id ) ) { return false; } // Assume true if not spam or deleted return true; } /** * Checks if user is not active. * * @since 2.0.0 bbPress (r3502) * * @param int $user_id The user ID to check. Defaults to current user ID * @return bool True if inactive, false if active */ function bbp_is_user_inactive( $user_id = 0 ) { return ! bbp_is_user_active( $user_id ); } /** * Checks if user is a keymaster * * @since 2.3.0 bbPress (r4783) * * @param int $user_id * @return bool True if keymaster, false if not */ function bbp_is_user_keymaster( $user_id = 0 ) { $_user_id = bbp_get_user_id( $user_id, false, true ); $retval = user_can( $_user_id, 'keep_gate' ); // Filter & return return (bool) apply_filters( 'bbp_is_user_keymaster', $retval, $_user_id, $user_id ); } /** * Does a user have a profile for the current site * * @since 2.2.0 bbPress (r4362) * * @param int $user_id User ID to check * * @return bool Whether or not the user has a profile on this blog_id. */ function bbp_user_has_profile( $user_id = 0 ) { // Assume every user has a profile $retval = true; // Validate user ID, default to displayed or current user $user_id = bbp_get_user_id( $user_id, true, true ); // Try to get this user's data $user = get_userdata( $user_id ); // No user found, return false if ( empty( $user ) ) { $retval = false; // User is inactive, and current user is not a keymaster } elseif ( ! bbp_is_user_keymaster() && bbp_is_user_inactive( $user->ID ) ) { $retval = false; } // Filter & return return (bool) apply_filters( 'bbp_show_user_profile', $retval, $user_id ); } /** Moderators ****************************************************************/ /** * Add a moderator to an object * * @since 2.6.0 bbPress (r6056) * * @param int $object_id Traditionally a post ID * @param int $user_id User ID * @param string $object_type Type of meta (post,term,user,comment) * * @return bool */ function bbp_add_moderator( $object_id = 0, $user_id = 0, $object_type = 'post' ) { return bbp_add_user_to_object( $object_id, $user_id, '_bbp_moderator_id', $object_type ); } /** * Remove a moderator user ID from an object * * @since 2.6.0 bbPress (r6056) * * @param int $object_id Traditionally a post ID * @param int $user_id User ID * @param string $object_type Type of meta (post,term,user,comment) * * @return bool */ function bbp_remove_moderator( $object_id = 0, $user_id = 0, $object_type = 'post' ) { return bbp_remove_user_from_object( $object_id, $user_id, '_bbp_moderator_id', $object_type ); } /** * Get user IDs of moderators for an object * * @since 2.6.0 bbPress (r6056) * * @param int $object_id Traditionally a post ID * @param string $object_type Type of meta (post,term,user,comment) * * @return array */ function bbp_get_moderator_ids( $object_id = 0, $object_type = 'post' ) { return bbp_get_users_for_object( $object_id, '_bbp_moderator_id', $object_type ); } /** * Get moderators for a specific object ID. Will return global moderators when * object ID is empty. * * @since 2.6.0 bbPress (r6056) * * @param int $object_id Traditionally a post ID * @param string $object_type Type of meta (post,term,user,comment) * * @return array */ function bbp_get_moderators( $object_id = 0, $object_type = 'post' ) { // Get global moderators if ( empty( $object_id ) ) { $users = get_users( array( 'role__in' => bbp_get_moderator_role(), ) ); // Get object moderators } else { $users = get_users( array( 'include' => bbp_get_moderator_ids( $object_id, $object_type ), ) ); } // Filter & return return (array) apply_filters( 'bbp_get_moderators', $users, $object_id, $object_type ); } ```