277 lines
7.0 KiB
PHP
277 lines
7.0 KiB
PHP
<?php
|
|
|
|
/**
|
|
* bbPress Forum Capabilites
|
|
*
|
|
* Used to map forum capabilities to WordPress's existing capabilities.
|
|
*
|
|
* @package bbPress
|
|
* @subpackage Capabilities
|
|
*/
|
|
|
|
/**
|
|
* Return forum capabilities
|
|
*
|
|
* @since 2.0.0 bbPress (r2593)
|
|
*
|
|
* @return array Forum capabilities
|
|
*/
|
|
function bbp_get_forum_caps() {
|
|
|
|
// Filter & return
|
|
return (array) apply_filters( 'bbp_get_forum_caps', array(
|
|
'edit_posts' => 'edit_forums',
|
|
'edit_others_posts' => 'edit_others_forums',
|
|
'publish_posts' => 'publish_forums',
|
|
'read_private_posts' => 'read_private_forums',
|
|
'read_hidden_posts' => 'read_hidden_forums',
|
|
'delete_posts' => 'delete_forums',
|
|
'delete_others_posts' => 'delete_others_forums'
|
|
) );
|
|
}
|
|
|
|
/**
|
|
* Maps forum capabilities
|
|
*
|
|
* @since 2.2.0 bbPress (r4242)
|
|
*
|
|
* @param array $caps Capabilities for meta capability
|
|
* @param string $cap Capability name
|
|
* @param int $user_id User id
|
|
* @param array $args Arguments
|
|
* @return array Actual capabilities for meta capability
|
|
*/
|
|
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 );
|
|
}
|
|
|
|
/**
|
|
* Can a user moderate a forum?
|
|
*
|
|
* @since 2.6.0 bbPress (r5834)
|
|
*
|
|
* @param int $user_id User id.
|
|
* @param int $forum_id Forum id.
|
|
*
|
|
* @return bool Return true if user is moderator of forum
|
|
*/
|
|
function bbp_is_user_forum_moderator( $user_id = 0, $forum_id = 0 ) {
|
|
$user_id = bbp_get_user_id( $user_id, false, empty( $user_id ) );
|
|
$forum_id = bbp_get_forum_id( $forum_id );
|
|
$retval = user_can( $user_id, 'moderate', $forum_id );
|
|
|
|
// Filter & return
|
|
return (bool) apply_filters( 'bbp_is_user_forum_moderator', $retval, $user_id, $forum_id );
|
|
}
|
|
|
|
/**
|
|
* Filter an array of forum IDs that are being excluded, and remove any forum
|
|
* IDs a user explicitly has access to.
|
|
*
|
|
* This typically means private or hidden forums the user has moderation rights
|
|
* to, but it can be filtered to mean just about anything.
|
|
*
|
|
* This function filters the return values of the following functions:
|
|
* - `bbp_get_private_forum_ids()`
|
|
* - `bbp_get_hidden_forum_ids()`
|
|
*
|
|
* @since 2.6.0 bbPress (r6426)
|
|
*
|
|
* @param array $forum_ids Forum IDs to check if the user ID is a moderator of
|
|
* @param int $user_id User ID to check if is a moderator of forums
|
|
*
|
|
* @return array
|
|
*/
|
|
function bbp_allow_forums_of_user( $forum_ids = array(), $user_id = 0 ) {
|
|
|
|
// Store the original forum IDs
|
|
$original_forum_ids = $forum_ids;
|
|
|
|
// Per-forum Moderators
|
|
if ( bbp_allow_forum_mods() ) {
|
|
|
|
// Loop through forum IDs
|
|
foreach ( $forum_ids as $key => $forum_id ) {
|
|
|
|
// Unset forum ID if user is a moderator
|
|
if ( bbp_is_user_forum_moderator( $user_id, $forum_id ) ) {
|
|
unset( $forum_ids[ $key ] );
|
|
}
|
|
}
|
|
}
|
|
|
|
// Filter & return
|
|
return (array) apply_filters( 'bbp_allow_forums_of_user', $forum_ids, $user_id, $original_forum_ids );
|
|
}
|