Changeset 6056 for trunk/src/includes/users/template.php

Timestamp:

06/05/2016 06:27:54 PM (8 years ago)

Author:

johnjamesjacoby

Message:

Moderators: Refactor per-forum moderators to use meta-data instead of mocked taxonomy terms.

If the future of Forums is a taxonomy (vs. a custom post-type) then a per-forum Moderator taxonomy for a Forum taxonomy won't work very well, for a few reasons:

• Scalability
• Taxonomies for taxonomies is a bit more inception than should be required for this simple feature
• Forum moderators do not require much of what taxonomy objects provide (permalinks, visibility, metadata, etc...)
• User taxonomy terms matching nicenames works okay for something like Automattic's P2 theme, but bbPress requires a user ID based solution to avoid data synchronization issues between nicenames & term slugs

So... the future of per-forum per-user capability mappings is in meta-data using map_meta_cap.

This commit:

• Removes the forum_mod taxonomy and surrounding code additions introduced in the first pass in r5834
• Renames forum_mod functions to forum_moderator to be more explicit
• Adds CRUD wrapper functions for per-forum moderator meta data
• Adds administrative interfaces for assigning moderators to forums for wp-admin and forum edit pages
• Adds helper functions for getting user nicenames & IDs

Note that this feature has now been refactored to no longer be forum specific (I.E. object agnostic) -- it's possible for any user access to be mapped based on the object type using any meta-data key. While this is currently useful for per-forum moderators, it may be user for per-topic blocking, per-topic-tag moderation, etc...

See #459.

File:

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

trunk/src/includes/users/template.php

@@ -2110 +2110 @@
     return (bool) apply_filters( 'bbp_current_user_can_access_anonymous_user_form', (bool) $retval );
 }
+
+/** Moderators ****************************************************************/
+
+/**
+ * Output the moderators of a forum
+ *
+ * @since 2.6.0 bbPress
+ *
+ * @param int   $forum_id Optional. Topic id
+ * @param array $args     See {@link bbp_get_moderator_list()}
+ * @uses bbp_get_moderator_list() To get the moderator list
+ */
+function bbp_moderator_list( $forum_id = 0, $args = array() ) {
+    echo bbp_get_moderator_list( $forum_id, $args );
+}
+
+    /**
+     * Return the moderators for an object
+     *
+     * @since 2.6.0 bbPress
+     *
+     * @param int   $object_id Optional. Object id
+     * @param array $args     This function supports these arguments:
+     *  - before: Before the tag list
+     *  - sep: Tag separator
+     *  - after: After the tag list
+     *
+     * @return string Moderator list of the object
+     */
+    function bbp_get_moderator_list( $object_id = 0, $args = array() ) {
+
+        // Parse arguments against default values
+        $r = bbp_parse_args( $args, array(
+            'before' => '<div class="bbp-moderators"><p>' . esc_html__( 'Moderators:', 'bbpress' ) . '&nbsp;',
+            'sep'    => ', ',
+            'after'  => '</p></div>',
+            'none'   => ''
+        ), 'get_moderator_list' );
+
+        // Get forum moderators
+        $user_ids = bbp_get_moderator_ids( $object_id );
+        if ( ! empty( $user_ids ) ) {
+
+            // In admin, use nicenames
+            if ( is_admin() ) {
+                $users = bbp_get_user_nicenames_from_ids( $user_ids );
+
+            // In theme, use display names & profile links
+            } else {
+                foreach ( $user_ids as $user_id ) {
+                    $users[] = bbp_get_user_profile_link( $user_id );
+                }
+            }
+
+            $retval = $r['before'] . implode( $r['sep'], $users ) . $r['after'];
+
+        // No forum moderators
+        } else {
+            $retval = $r['none'];
+        }
+
+        return apply_filters( 'bbp_get_moderator_list', $retval );
+    }