Changeset 5834 for trunk/src/includes/forums/template.php

Timestamp:

07/15/2015 03:59:23 PM (10 years ago)

Author:

johnjamesjacoby

Message:

Moderators: First pass at per-forum moderators.

This commit introduces a powerful feature commonly found in other popular forum software that has been on our wishlist for nearly 9 years. It includes the following changes:

• Custom forum-mod taxonomy for assigning user nicenames to forum IDs
• Associated functions for defining capabilities, labels, etc...
• New capability filters for ensuring forum moderators have the ability to moderate forums even without the moderator role assignment
• New option for toggling the entire feature on/off (on by default)

Props jmdodd, netweb. See #459.

File:

• trunk/src/includes/forums/template.php (modified) (1 diff)

trunk/src/includes/forums/template.php

@@ -2178 +2178 @@
     }
 
+/** Moderators ****************************************************************/
+
+/**
+ * Output the unique id of the forum moderators taxonomy
+ *
+ * @since bbPress (r5834)
+ *
+ * @uses bbp_get_forum_mod_tax_id() To get the forum modorator taxonomy ID
+ */
+function bbp_forum_mod_tax_id() {
+    echo bbp_get_forum_mod_tax_id();
+}
+    /**
+     * Return the unique id of the forum moderators taxonomy
+     *
+     * @since bbPress (r5834)
+     *
+     * @uses apply_filters() Calls 'bbp_get_forum_mod_tax_id' with the forum
+     *                        moderator taxonomy id
+     * @return string The unique forum moderators taxonomy
+     */
+    function bbp_get_forum_mod_tax_id() {
+        return apply_filters( 'bbp_get_forum_mod_tax_id', bbpress()->forum_mod_tax_id );
+    }
+
+/**
+ * Return array of labels used by the forum-mod taxonomy
+ *
+ * @since bbPress (r5834)
+ *
+ * @uses apply_filters() Calls 'bbp_get_forum_mod_tax_id' with the forum
+ *                        moderator taxonomy labels
+ * @return array
+ */
+function bbp_get_forum_mod_tax_labels() {
+    return apply_filters( 'bbp_get_forum_mod_tax_labels', array(
+        'name'                       => __( 'Forum Moderators',     'bbpress' ),
+        'singular_name'              => __( 'Forum Moderator',      'bbpress' ),
+        'search_items'               => __( 'Search Moderators',    'bbpress' ),
+        'popular_items'              => __( 'Popular Moderators',   'bbpress' ),
+        'all_items'                  => __( 'All Moderators',       'bbpress' ),
+        'edit_item'                  => __( 'Edit Moderator',       'bbpress' ),
+        'update_item'                => __( 'Update Moderator',     'bbpress' ),
+        'add_new_item'               => __( 'Add New Moderator',    'bbpress' ),
+        'new_item_name'              => __( 'New Moderator Name',   'bbpress' ),
+        'view_item'                  => __( 'View Forum Moderator', 'bbpress' ),
+        'separate_items_with_commas' => __( 'Separate moderator names with commas', 'bbpress' ),
+    ) );
+}
+
+/**
+ * Output a the moderators of a forum
+ *
+ * @param int   $forum_id Optional. Topic id
+ * @param array $args     See {@link bbp_get_forum_mod_list()}
+ * @uses bbp_get_topic_tag_list() To get the forum mod list
+ */
+function bbp_forum_mod_list( $forum_id = 0, $args = array() ) {
+    echo bbp_get_forum_mod_list( $forum_id, $args );
+}
+    /**
+     * Return the moderators of a forum
+     *
+     * @param int   $forum_id Optional. Forum id
+     * @param array $args     This function supports these arguments:
+     *  - before: Before the tag list
+     *  - sep: Tag separator
+     *  - after: After the tag list
+     * @uses bbp_get_forum_id()  To get the forum id
+     * @uses get_the_term_list() To get the moderator list
+     *
+     * @return string Moderator list of the forum
+     */
+    function bbp_get_forum_mod_list( $forum_id = 0, $args = array() ) {
+
+        // Bail if forum-mods are off
+        if ( ! bbp_allow_forum_mods() ) {
+            return;
+        }
+
+        // Parse arguments against default values
+        $r = bbp_parse_args( $args, array(
+            'before' => '<div class="bbp-forum-mods"><p>' . esc_html__( 'Moderators:', 'bbpress' ) . '&nbsp;',
+            'sep'    => ', ',
+            'after'  => '</p></div>'
+        ), 'get_forum_mod_list' );
+
+        $forum_id = bbp_get_forum_id( $forum_id );
+
+        $retval   = get_the_term_list( $forum_id, bbp_get_forum_mod_id(), $r['before'], $r['sep'], $r['after'] );
+
+        return $retval;
+    }
+
 /** Forms *********************************************************************/