setup_variables(); $this->setup_actions(); $this->setup_filters(); $this->maybe_unset_forum_menu(); $this->fully_loaded(); } /** * Setup the group forums class variables. * * @since 2.3.0 bbPress (r4553) */ private function setup_variables() { // Component Name $this->name = esc_html__( 'Forum', 'bbpress' ); $this->nav_item_name = esc_html__( 'Forum', 'bbpress' ); // Component slugs (hardcoded to match bbPress 1.x functionality) $this->slug = 'forum'; $this->topic_slug = 'topic'; $this->reply_slug = 'reply'; // Forum component is visible $this->visibility = 'public'; // Set positions towards end $this->create_step_position = 15; $this->nav_item_position = 10; // Allow create step and show in nav $this->enable_create_step = true; $this->enable_nav_item = true; $this->enable_edit_item = true; // Template file to load, and action to hook display on to $this->template_file = 'groups/single/plugins'; $this->display_hook = 'bp_template_content'; } /** * Setup the group forums class actions. * * @since 2.3.0 bbPress (r4553) */ private function setup_actions() { // Possibly redirect add_action( 'bbp_template_redirect', array( $this, 'redirect_canonical' ) ); // Remove group forum cap map when view is done add_action( 'bbp_after_group_forum_display', array( $this, 'remove_group_forum_meta_cap_map' ) ); // Validate group IDs when editing topics & replies add_action( 'bbp_edit_topic_pre_extras', array( $this, 'validate_topic_forum_id' ) ); add_action( 'bbp_edit_reply_pre_extras', array( $this, 'validate_reply_to_id' ) ); // Check if group-forum attributes should be changed add_action( 'groups_group_after_save', array( $this, 'update_group_forum' ) ); // bbPress needs to listen to BuddyPress group deletion add_action( 'groups_before_delete_group', array( $this, 'disconnect_forum_from_group' ) ); // Adds a bbPress meta-box to the new BuddyPress Group Admin UI add_action( 'bp_groups_admin_meta_boxes', array( $this, 'group_admin_ui_edit_screen' ) ); // Saves the bbPress options if they come from the BuddyPress Group Admin UI add_action( 'bp_group_admin_edit_after', array( $this, 'edit_screen_save' ) ); // Adds a hidden input value to the "Group Settings" page add_action( 'bp_before_group_settings_admin', array( $this, 'group_settings_hidden_field' ) ); } /** * Setup the group forums class filters. * * @since 2.3.0 bbPress (r4553) */ private function setup_filters() { // Group forum pagination add_filter( 'bbp_topic_pagination', array( $this, 'topic_pagination' ) ); add_filter( 'bbp_replies_pagination', array( $this, 'replies_pagination' ) ); add_filter( 'bbp_get_global_object', array( $this, 'rewrite_pagination' ), 10, 2 ); // Tweak the redirect field add_filter( 'bbp_new_topic_redirect_to', array( $this, 'new_topic_redirect_to' ), 10, 3 ); add_filter( 'bbp_new_reply_redirect_to', array( $this, 'new_reply_redirect_to' ), 10, 3 ); // Map forum/topic/reply permalinks to their groups add_filter( 'bbp_get_forum_permalink', array( $this, 'map_forum_permalink_to_group' ), 10, 2 ); add_filter( 'bbp_get_topic_permalink', array( $this, 'map_topic_permalink_to_group' ), 10, 2 ); add_filter( 'bbp_get_reply_permalink', array( $this, 'map_reply_permalink_to_group' ), 10, 2 ); // Map reply edit links to their groups add_filter( 'bbp_get_reply_edit_url', array( $this, 'map_reply_edit_url_to_group' ), 10, 2 ); // Map assorted template function permalinks add_filter( 'post_link', array( $this, 'post_link' ), 10, 2 ); add_filter( 'page_link', array( $this, 'page_link' ), 10, 2 ); add_filter( 'post_type_link', array( $this, 'post_type_link' ), 10, 2 ); // Map group forum activity items to groups add_filter( 'bbp_before_record_activity_parse_args', array( $this, 'map_activity_to_group' ) ); // Allow group members to receive group forum notifications add_filter( 'bbp_subscription_user_can_view_forum', array( $this, 'subscription_user_can_view_forum' ), 10, 3 ); // Restrict private and hidden group forums outside of group requests add_filter( 'bbp_map_meta_caps', array( $this, 'map_group_forum_read_meta_caps' ), 20, 4 ); add_filter( 'bbp_get_excluded_forum_ids', array( $this, 'exclude_group_forum_ids' ), 20 ); /** Caps **************************************************************/ // Only add these filters if inside a group forum if ( bp_is_single_item() && bp_is_group() && bp_is_current_action( $this->slug ) ) { // Ensure bbp_is_single_forum() returns true on group forums. add_filter( 'bbp_is_single_forum', array( $this, 'is_single_forum' ) ); // Ensure bbp_is_single_topic() returns true on group forum topics. add_filter( 'bbp_is_single_topic', array( $this, 'is_single_topic' ) ); // Allow group member to view private/hidden forums add_filter( 'bbp_map_meta_caps', array( $this, 'map_group_forum_meta_caps' ), 10, 4 ); // Group member permissions to view the topic and reply forms add_filter( 'bbp_current_user_can_access_create_topic_form', array( $this, 'form_permissions' ) ); add_filter( 'bbp_current_user_can_access_create_reply_form', array( $this, 'form_permissions' ) ); } } /** * Check whether a user can view a private or hidden group forum. * * @since 2.7.0 bbPress (r7495) * * @param int $user_id User ID. * @param int $forum_id Forum ID. * @return bool|null Whether the user can view the group forum, or null when * the forum is not a restricted group forum. */ public function user_can_view_group_forum( $user_id = 0, $forum_id = 0 ) { $user_id = bbp_get_user_id( $user_id, false, false ); $forum_id = bbp_get_forum_id( $forum_id ); $group_ids = bbp_get_forum_group_ids( $forum_id ); // Keep normal bbPress permissions for other forums if ( empty( $group_ids ) || ! bbp_is_forum_restricted( $forum_id, false ) ) { return null; } // Preserve access for global and per-forum moderators if ( bbp_is_user_forum_moderator( $user_id, $forum_id ) ) { return true; } // Allow current, non-banned members of any attached group foreach ( $group_ids as $group_id ) { if ( false === groups_is_user_banned( $user_id, $group_id ) && false !== groups_is_user_member( $user_id, $group_id ) ) { return true; } } return false; } /** * Map read access for private and hidden group forums in every request. * * @since 2.7.0 bbPress (r7495) * * @param array $caps Capabilities for the meta capability. * @param string $cap Capability name. * @param int $user_id User ID. * @param array $args Arguments. * @return array Actual capabilities for the meta capability. */ public function map_group_forum_read_meta_caps( $caps = array(), $cap = '', $user_id = 0, $args = array() ) { if ( ( 'read_forum' !== $cap ) || empty( $args[0] ) ) { return $caps; } // Preserve an earlier hard denial, including inactive users and // restricted ancestors the user cannot read if ( in_array( 'do_not_allow', $caps, true ) ) { return $caps; } $can_view = $this->user_can_view_group_forum( $user_id, $args[0] ); if ( null !== $can_view ) { $caps = $can_view ? array( 'participate' ) : array( 'do_not_allow' ); } return $caps; } /** * Exclude private and hidden group forums a user cannot view. * * @since 2.7.0 bbPress (r7495) * @since 2.6.19 bbPress (r7677) Exclude unreadable descendants. * * @param array $forum_ids Forum IDs already excluded. * @return array Forum IDs the user cannot view. */ public function exclude_group_forum_ids( $forum_ids ) { $user_id = bbp_get_current_user_id(); $restricted = array_merge( bbp_get_private_forum_ids(), bbp_get_hidden_forum_ids() ); $restricted = wp_parse_id_list( $restricted ); foreach ( $restricted as $forum_id ) { // Skip forums that are not attached to groups if ( empty( bbp_get_forum_group_ids( $forum_id ) ) ) { continue; } if ( ! user_can( $user_id, 'read_forum', $forum_id ) ) { // Exclude descendants too, except those this user can read. $parents = array( $forum_id ); $seen = array( $forum_id => true ); $readable = array(); $forum_ids[] = $forum_id; while ( ! empty( $parents ) ) { $parent_id = array_shift( $parents ); foreach ( bbp_forum_query_all_subforum_ids( $parent_id ) as $child_id ) { $child_id = (int) $child_id; if ( isset( $seen[ $child_id ] ) ) { continue; } $seen[ $child_id ] = true; $parents[] = $child_id; if ( user_can( $user_id, 'read_forum', $child_id ) ) { $readable[] = $child_id; } else { $forum_ids[] = $child_id; } } } $forum_ids = array_diff( $forum_ids, $readable ); continue; } // Include readable descendants that inherited this restriction $readable = array( $forum_id ); foreach ( $forum_ids as $excluded_id ) { if ( in_array( $forum_id, bbp_get_forum_ancestors( $excluded_id ), true ) ) { $readable[] = $excluded_id; } } foreach ( $readable as $readable_id ) { if ( user_can( $user_id, 'read_forum', $readable_id ) ) { $forum_ids = array_diff( $forum_ids, array( $readable_id ) ); } } } return wp_parse_id_list( $forum_ids ); } /** * Allow a group member to receive notifications from an attached forum. * * Unlike the request-specific capability mapping, this check accepts an * explicit user ID so it can validate subscription recipients. * * @since 2.6.17 bbPress (r7493) * * @param bool $retval Whether the user can view the forum. * @param int $user_id User ID. * @param int $forum_id Forum ID. * @return bool Whether the user can view the forum. */ public function subscription_user_can_view_forum( $retval, $user_id, $forum_id ) { $can_view = $this->user_can_view_group_forum( $user_id, $forum_id ); return ( null === $can_view ) ? $retval : ( $retval && $can_view ); } /** * Allow the variables, actions, and filters to be modified by third party * plugins and themes. * * @since 2.6.0 bbPress (r6808) */ private function fully_loaded() { do_action_ref_array( 'bbp_buddypress_groups_loaded', array( $this ) ); } /** * Ensure that bbp_is_single_forum() returns true on group forum pages. * * @see https://bbpress.trac.wordpress.org/ticket/2974 * * @since 2.6.0 bbPress (r6367) * * @param bool $retval Current boolean. * @return bool */ public function is_single_forum( $retval = false ) { // Additional BuddyPress specific single-forum conditionals if ( ( false === $retval ) && ! bp_is_action_variable( $this->topic_slug, 0 ) ) { $retval = true; } return $retval; } /** * Ensure that bbp_is_single_topic() returns true on group forum topic pages. * * @see https://bbpress.trac.wordpress.org/ticket/2974 * * @since 2.6.0 bbPress (r6220) * * @param bool $retval Current boolean. * @return bool */ public function is_single_topic( $retval = false ) { // Additional BuddyPress specific single-topic conditionals if ( ( false === $retval ) && bp_is_action_variable( $this->topic_slug, 0 ) && bp_action_variable( 1 ) ) { $retval = true; } return $retval; } /** * The primary display function for group forums. * * @since 2.1.0 bbPress (r3552) * * @param int $group_id ID of the current group. Available only on BP 2.2+. */ public function display( $group_id = null ) { // Prevent Topic Parent from appearing add_action( 'bbp_theme_before_topic_form_forum', array( $this, 'ob_start' ) ); add_action( 'bbp_theme_after_topic_form_forum', array( $this, 'ob_end_clean' ) ); add_action( 'bbp_theme_after_topic_form_forum', array( $this, 'topic_parent' ) ); // Prevent Forum Parent from appearing add_action( 'bbp_theme_before_forum_form_parent', array( $this, 'ob_start' ) ); add_action( 'bbp_theme_after_forum_form_parent', array( $this, 'ob_end_clean' ) ); add_action( 'bbp_theme_after_forum_form_parent', array( $this, 'forum_parent' ) ); // Hide breadcrumb add_filter( 'bbp_no_breadcrumb', '__return_true' ); $this->display_forums( 0 ); } /** * Maybe unset the group forum nav item if group does not have a forum. * * @since 2.3.0 bbPress (r4553) * * @return If not viewing a single group. */ public function maybe_unset_forum_menu() { // Bail if not viewing a single group if ( ! bp_is_group() ) { return; } // Are forums enabled for this group? $checked = bp_get_new_group_enable_forum() || groups_get_groupmeta( bp_get_new_group_id(), 'forum_id' ); // Tweak the nav item variable based on if group has forum or not $this->enable_nav_item = (bool) $checked; } /** * Allow group members to have advanced privileges in group forum topics. * * @since 2.3.0 bbPress (r4716) * * @param array $caps * @param string $cap * @param int $user_id * @param array $args * @return array */ public function map_group_forum_meta_caps( $caps = array(), $cap = '', $user_id = 0, $args = array() ) { // Group request state only describes the logged-in user if ( bbp_get_current_user_id() !== (int) $user_id ) { return (array) apply_filters( 'bbp_map_group_forum_topic_meta_caps', $caps, $cap, $user_id, $args ); } // Never replace an earlier hard denial if ( in_array( 'do_not_allow', $caps, true ) ) { return (array) apply_filters( 'bbp_map_group_forum_topic_meta_caps', $caps, $cap, $user_id, $args ); } // Explicit objects must belong to the current group if ( ! empty( $args[0] ) ) { $post_id = (int) $args[0]; $post_type = get_post_type( $post_id ); switch ( $post_type ) { case bbp_get_forum_post_type() : $forum_id = $post_id; break; case bbp_get_topic_post_type() : $forum_id = bbp_get_topic_forum_id( $post_id ); break; case bbp_get_reply_post_type() : $forum_id = bbp_get_reply_forum_id( $post_id ); break; default : $forum_id = 0; break; } if ( empty( $forum_id ) || ! in_array( $forum_id, bbp_get_group_forum_ids(), true ) ) { return (array) apply_filters( 'bbp_map_group_forum_topic_meta_caps', $caps, $cap, $user_id, $args ); } } switch ( $cap ) { // If user is a group mmember, allow them to create content. case 'publish_replies' : case 'publish_topics' : if ( bbp_group_is_banned() ) { $caps = array( 'do_not_allow' ); } elseif ( bbp_group_is_member() || bbp_group_is_mod() || bbp_group_is_admin() ) { $caps = array( 'participate' ); } break; // If user is a group mod ar admin, map to participate cap. case 'moderate' : case 'edit_topic' : case 'edit_reply' : case 'view_trash' : case 'edit_others_replies' : case 'edit_others_topics' : if ( bbp_group_is_mod() || bbp_group_is_admin() ) { $caps = array( 'participate' ); } break; // If user is a group admin, allow them to delete topics and replies. case 'delete_topic' : case 'delete_reply' : if ( bbp_group_is_admin() ) { $caps = array( 'participate' ); } break; // If user is a group admin, allow them to manage forum attributes. case 'manage_forum_attributes' : $forum_id = ! empty( $args[0] ) ? bbp_get_forum_id( $args[0] ) : 0; if ( bbp_is_forum( $forum_id ) && bbp_group_is_admin() && in_array( $forum_id, bbp_get_group_forum_ids(), true ) ) { $caps = array( 'participate' ); } break; } /** * Filters the Group Forum Topic meta capabilities. * * @since 2.2.0 bbPress (r4435) * * @param array $caps Capabilities for the meta capability. * @param string $cap Capability name. * @param int $user_id User ID. * @param array $args Arguments. */ return (array) apply_filters( 'bbp_map_group_forum_topic_meta_caps', $caps, $cap, $user_id, $args ); } /** * Remove the topic meta cap map, so it doesn't interfere with sidebars. * * @since 2.3.0 bbPress (r4717) */ public function remove_group_forum_meta_cap_map() { remove_filter( 'bbp_map_meta_caps', array( $this, 'map_group_forum_meta_caps' ), 10 ); } /** * Validate the forum ID for a topic in a group forum. * * This method ensures that when a topic is saved, it is only allowed to be * saved to a forum that is either: * * - A forum in the current group * - A forum the current user can moderate outside of this group * * If all checks fail, an error gets added to prevent the topic from saving. * * @since 2.6.14 bbPress (r7060) * * @param int $topic_id Topic id. */ public function validate_topic_forum_id( $topic_id = 0 ) { // Bail if no topic if ( empty( $topic_id ) ) { return; } // Get current forum ID $forum_id = bbp_get_topic_forum_id( $topic_id ); // Bail if not a group forum if ( ! bbp_is_forum_group_forum( $forum_id ) ) { return; } // Get current group ID $group_id = bp_get_current_group_id(); // Bail if unknown group ID if ( empty( $group_id ) ) { return; } // Get group forum IDs $forum_ids = bbp_get_group_forum_ids( $group_id ); // Get posted forum ID $new_forum_id = ! empty( $_POST['bbp_forum_id'] ) ? absint( $_POST['bbp_forum_id'] ) : 0; // Bail if new forum ID is a forum in this group if ( in_array( $new_forum_id, $forum_ids, true ) ) { return; } // Get the current user ID $user_id = bbp_get_current_user_id(); // Bail if current user can moderate the new forum ID if ( bbp_is_user_forum_moderator( $user_id, $new_forum_id ) ) { return; } // If everything else has failed, then something is wrong and we need // to add an error to prevent this topic from saving. bbp_add_error( 'bbp_topic_forum_id', __( 'Error: Forum ID is invalid.', 'bbpress' ) ); } /** * Validate the reply to for a reply in a group forum. * * This method ensures that when a reply to is saved, it is only allowed to * be saved to the current topic. * * If all checks fail, an error gets added to prevent the reply from saving. * * @since 2.6.14 bbPress (r7060) * * @param int $reply_id Reply id. */ public function validate_reply_to_id( $reply_id = 0 ) { // Bail if no reply if ( empty( $reply_id ) ) { return; } // Get posted reply to $new_reply_to = ! empty( $_POST['bbp_reply_to'] ) ? absint( $_POST['bbp_reply_to'] ) : 0; // Bail if no reply to (assumes topic ID) if ( empty( $new_reply_to ) ) { return; } // Get current forum ID $forum_id = bbp_get_reply_forum_id( $reply_id ); // Bail if not a group forum if ( ! bbp_is_forum_group_forum( $forum_id ) ) { return; } // Get current group ID $group_id = bp_get_current_group_id(); // Bail if unknown group ID if ( empty( $group_id ) ) { return; } // Get current topic ID $topic_id = bbp_get_reply_topic_id( $reply_id ); // Get topic reply IDs $reply_ids = bbp_get_public_child_ids( $topic_id, bbp_get_reply_post_type() ); // Avoid recursion unset( $reply_ids[ $reply_id ] ); // Bail if new reply parent ID is in this topic if ( in_array( $new_reply_to, $reply_ids, true ) ) { return; } // Add an error to prevent this reply from saving. bbp_add_error( 'bbp_reply_to_id', __( 'Error: Reply To is invalid.', 'bbpress' ) ); } /** Edit ******************************************************************/ /** * Show forums and new forum form when editing a group. * * @since 2.1.0 bbPress (r3552) * * @param object $group (the group to edit if in Group Admin UI) */ public function edit_screen( $group = false ) { $forum_id = 0; $group_id = empty( $group->id ) ? bp_get_new_group_id() : $group->id; $forum_ids = bbp_get_group_forum_ids( $group_id ); // Get the first forum ID if ( ! empty( $forum_ids ) ) { $forum_id = (int) is_array( $forum_ids ) ? $forum_ids[0] : $forum_ids; } // Should box be checked already? $checked = is_admin() ? bp_group_is_forum_enabled( $group ) : bp_get_new_group_enable_forum() || bp_group_is_forum_enabled( bp_get_group_id() ); ?>
slug, 'forum_group_admin_ui' ); } else { wp_nonce_field( 'groups_edit_save_' . $this->slug ); } } /** * Save the Group Forum data on edit. * * @since 2.1.0 bbPress (r3552) * * @param int $group_id (to handle Group Admin UI hook bp_group_admin_edit_after). */ public function edit_screen_save( $group_id = 0 ) { // Bail if not a POST action if ( ! bbp_is_post_request() ) { return; } // Admin Nonce check if ( is_admin() ) { check_admin_referer( 'groups_edit_save_' . $this->slug, 'forum_group_admin_ui' ); // Theme-side Nonce check } elseif ( ! bbp_verify_nonce_request( 'groups_edit_save_' . $this->slug ) ) { bbp_add_error( 'bbp_edit_group_forum_screen_save', __( 'Error: Are you sure you wanted to do that?', 'bbpress' ) ); return; } $edit_forum = ! empty( $_POST['bbp-edit-group-forum'] ) ? true : false; $forum_id = 0; $group_id = ! empty( $group_id ) ? $group_id : bp_get_current_group_id(); // Keymasters have the ability to reconfigure forums if ( bbp_is_user_keymaster() ) { $forum_ids = ! empty( $_POST['bbp_group_forum_id'] ) ? (array) (int) $_POST['bbp_group_forum_id'] : array(); // Use the existing forum IDs } else { $forum_ids = array_values( bbp_get_group_forum_ids( $group_id ) ); } // Normalize group forum relationships now if ( ! empty( $forum_ids ) ) { // Loop through forums, and make sure they exist foreach ( $forum_ids as $index => $forum_id ) { // Look for forum $forum = bbp_get_forum( $forum_id ); // No forum exists, so break the relationship if ( empty( $forum ) ) { $this->remove_forum( array( 'forum_id' => $forum_id, 'group_id' => $group_id ) ); unset( $forum_ids[ $index ] ); } } // No support for multiple forums yet $forum_ids = array_values( $forum_ids ); $forum_id = ! empty( $forum_ids ) ? (int) $forum_ids[0] : 0; } // Update the group ID and forum ID relationships bbp_update_group_forum_ids( $group_id, (array) $forum_ids ); if ( ! empty( $forum_id ) ) { bbp_update_forum_group_ids( $forum_id, (array) $group_id ); } // Update the group forum setting $group = $this->toggle_group_forum( $group_id, $edit_forum ); // Create a new forum if ( empty( $forum_id ) && ( true === $edit_forum ) ) { // Set the default forum status switch ( $group->status ) { case 'hidden' : $status = bbp_get_hidden_status_id(); break; case 'private' : $status = bbp_get_private_status_id(); break; case 'public' : default : $status = bbp_get_public_status_id(); break; } // Create the initial forum $forum_id = bbp_insert_forum( array( 'post_parent' => bbp_get_group_forums_root_id(), 'post_title' => $group->name, 'post_content' => $group->description, 'post_status' => $status ) ); // Setup forum args with forum ID $new_forum_args = array( 'forum_id' => $forum_id ); // If in admin, also include the group ID if ( is_admin() && ! empty( $group_id ) ) { $new_forum_args['group_id'] = $group_id; } // Run the BP-specific functions for new groups $this->new_forum( $new_forum_args ); } // Redirect after save when not in admin if ( ! is_admin() ) { bp_core_redirect( trailingslashit( $this->group_url( buddypress()->groups->current_group ) . '/admin/' . $this->slug ) ); } } /** * Adds a meta-box to BuddyPress Group Admin UI. * * @since 2.3.0 bbPress (r4815) */ public function group_admin_ui_edit_screen() { add_meta_box( 'bbpress_group_admin_ui_meta_box', esc_html_x( 'Forum', 'group admin edit screen', 'bbpress' ), array( $this, 'group_admin_ui_display_metabox' ), get_current_screen()->id, 'side', 'core' ); } /** * Displays the bbPress meta-box in BuddyPress Group Admin UI. * * @since 2.3.0 bbPress (r4815) * * @param object $item (group object). */ public function group_admin_ui_display_metabox( $item ) { $this->edit_screen( $item ); } /** Create ****************************************************************/ /** * Show forums and new forum form when creating a group. * * @since 2.1.0 bbPress (r3552) */ public function create_screen( $group_id = 0 ) { // Bail if not looking at this screen if ( ! bp_is_group_creation_step( $this->slug ) ) { return false; } // Check for possibly empty group_id if ( empty( $group_id ) ) { $group_id = bp_get_new_group_id(); } $checked = bp_get_new_group_enable_forum() || groups_get_groupmeta( $group_id, 'forum_id' ); ?>