bbp_map_forum_meta_caps( array $caps = array(), string $cap = '', int $user_id, array $args = array() )
Maps forum capabilities
Description Description
Parameters Parameters
- $caps
-
(Optional) Capabilities for meta capability
Default value: array()
- $cap
-
(Optional) Capability name
Default value: ''
- $user_id
-
(Required) User id
- $args
-
(Optional) Arguments
Default value: array()
Return Return
(array) Actual capabilities for meta capability
Source Source
File: includes/forums/capabilities.php
function bbp_map_forum_meta_caps( $caps = array(), $cap = '', $user_id = 0, $args = array() ) { // What capability is being checked? switch ( $cap ) { /** Reading ***********************************************************/ case 'read_private_forums' : case 'read_hidden_forums' : // Moderators can always read private/hidden forums if ( user_can( $user_id, 'moderate' ) ) { $caps = array( 'moderate' ); } break; case 'read_forum' : // User cannot spectate if ( ! user_can( $user_id, 'spectate' ) ) { $caps = array( 'do_not_allow' ); // Do some post ID based logic } else { // Bail if no post ID if ( empty( $args[0] ) ) { break; } // Get the post. $_post = get_post( $args[0] ); if ( ! empty( $_post ) ) { // Get caps for post type object $post_type = get_post_type_object( $_post->post_type ); // Post is public if ( bbp_get_public_status_id() === $_post->post_status ) { $caps = array( 'spectate' ); // User is author so allow read } elseif ( (int) $user_id === (int) $_post->post_author ) { $caps = array( 'spectate' ); // Moderators can always read forum content } elseif ( user_can( $user_id, 'moderate', $_post->ID ) ) { $caps = array( 'spectate' ); // Private } elseif ( bbp_get_hidden_status_id() === $_post->post_status ) { $caps = array( $post_type->cap->read_hidden_posts ); // Hidden } elseif ( bbp_get_private_status_id() === $_post->post_status ) { $caps = array( $post_type->cap->read_private_posts ); // Unknown, so map to private } else { $caps = array( $post_type->cap->read_private_posts ); } } } break; /** Publishing ********************************************************/ case 'publish_forums' : // Moderators can always edit if ( user_can( $user_id, 'moderate' ) ) { $caps = array( 'moderate' ); } break; /** Editing ***********************************************************/ // Used primarily in wp-admin case 'edit_forums' : case 'edit_others_forums' : // Moderators can always edit if ( bbp_is_user_keymaster( $user_id ) ) { $caps = array( 'spectate' ); // Otherwise, block } else { $caps = array( 'do_not_allow' ); } break; // Used everywhere case 'edit_forum' : // Bail if no post ID if ( empty( $args[0] ) ) { break; } // Get the post. $_post = get_post( $args[0] ); if ( ! empty( $_post ) ) { // Get caps for post type object $post_type = get_post_type_object( $_post->post_type ); // Add 'do_not_allow' cap if user is spam or deleted if ( bbp_is_user_inactive( $user_id ) ) { $caps = array( 'do_not_allow' ); // Moderators can always read forum content } elseif ( user_can( $user_id, 'moderate', $_post->ID ) ) { $caps = array( 'spectate' ); // User is author so allow edit if not in admin } elseif ( ! is_admin() && ( (int) $user_id === (int) $_post->post_author ) ) { $caps = array( $post_type->cap->edit_posts ); // Unknown, so map to edit_others_posts } else { $caps = array( $post_type->cap->edit_others_posts ); } } break; /** Deleting **********************************************************/ // Allow forum authors to delete forums (for BuddyPress groups, etc) case 'delete_forum' : // Bail if no post ID if ( empty( $args[0] ) ) { break; } // Get the post. $_post = get_post( $args[0] ); if ( ! empty( $_post ) ) { // Get caps for post type object $post_type = get_post_type_object( $_post->post_type ); // Add 'do_not_allow' cap if user is spam or deleted if ( bbp_is_user_inactive( $user_id ) ) { $caps = array( 'do_not_allow' ); // User is author so allow to delete } elseif ( (int) $user_id === (int) $_post->post_author ) { $caps = array( $post_type->cap->delete_posts ); // Unknown so map to delete_others_posts } else { $caps = array( $post_type->cap->delete_others_posts ); } } break; /** Admin *************************************************************/ // Forum admin area. case 'bbp_forums_admin' : $caps = array( 'edit_forums' ); break; } // Filter & return return (array) apply_filters( 'bbp_map_forum_meta_caps', $caps, $cap, $user_id, $args ); }
Changelog Changelog
Version | Description |
---|---|
2.2.0 | Introduced. |