Changeset 5834 for trunk/src/includes/users/functions.php

Timestamp:

07/15/2015 03:59:23 PM (9 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/users/functions.php (modified) (1 diff)

trunk/src/includes/users/functions.php

@@ -1906 +1906 @@
 }
 
+/** User Nicename Taxonomies **************************************************/
+
+/**
+ * Return the term id for a given user id and taxonomy
+ *
+ * @since bbPress (r5834)
+ *
+ * @param int    $user_id User id.
+ * @param string $taxonomy Taxonomy.
+ * @uses get_userdata() To get the user data
+ * @uses taxonomy_exists() To make sure the taxonomy exists
+ * @uses get_term_by() To get the term by name
+ *
+ * @return boolean|int Return false early, or if not found, or int term id
+ */
+function bbp_get_user_taxonomy_term_id( $user_id = 0, $taxonomy = '' ) {
+
+    // Bail if no user ID.
+    if ( empty( $user_id ) ) {
+        return false;
+    }
+
+    // Bail if user does not exist.
+    $user = get_userdata( $user_id );
+    if ( empty( $user ) ) {
+        return false;
+    }
+
+    // Bail if no taxonomy.
+    if ( empty( $taxonomy ) || ! taxonomy_exists( $taxonomy ) ) {
+        return false;
+    }
+
+    // Get the term id.
+    $term = get_term_by( 'name', $user->user_nicename, $taxonomy );
+    if ( ! empty( $term ) ) {
+        return $term->term_id;
+    }
+
+    return false;
+}
+
+/**
+ * Return the user id for a given term id and taxonomy
+ *
+ * @since bbPress (r5834)
+ *
+ * @param int    $term_id Term id.
+ * @param string $taxonomy Taxonomy.
+ * @uses taxonomy_exists() To make sure the taxonomy exists
+ * @uses get_term() To get the term by term id
+ * @uses get_user_by() To get the user by nicename
+ *
+ * @return boolean|int Return false early, or if not found, or int user id
+ */
+function bbp_get_term_taxonomy_user_id( $term_id = 0, $taxonomy = '' ) {
+
+    // Bail if no user ID.
+    if ( empty( $term_id ) ) {
+        return false;
+    }
+
+    // Bail if no taxonomy.
+    if ( empty( $taxonomy ) || ! taxonomy_exists( $taxonomy ) ) {
+        return false;
+    }
+
+    // Bail if no term exists.
+    $term = get_term( $term_id, $taxonomy );
+    if ( empty( $term ) ) {
+        return false;
+    }
+
+    // Get the user by nicename.
+    $nicename = $term->name;
+    $user     = get_user_by( 'slug', $nicename );
+    if ( ! empty( $user ) ) {
+        return $user->ID;
+    }
+
+    return false;
+}
+
+function bbp_filter_forum_mod_term_link( $termlink = '', $term = '', $taxonomy = '' ) {
+
+    // Bail if taxonomy is not forum mod
+    if ( bbp_get_forum_mod_tax_id() !== $taxonomy ) {
+        return $termlink;
+    }
+
+    // Bail if forum mods is not allowed
+    if ( ! bbp_allow_forum_mods() ) {
+        return $termlink;
+    }
+
+    // Get user ID from taxonomy term
+    $user_id = bbp_get_term_taxonomy_user_id( $term->term_id, bbp_get_forum_mod_tax_id() );
+
+    if ( is_admin() ) {
+
+        // Get the moderator's display name
+        $display_name = get_userdata( $user_id )->display_name;
+        $user_link    = get_edit_user_link( $user_id );
+
+        // Link or name only
+        if ( ! empty( $user_link ) ) {
+            $retval = '<a href="' . esc_url( $user_link ) . '">' . esc_html( $display_name ) . '</a>';
+
+        // Can't edit
+        } else {
+            $retval = $display_name;
+        }
+
+    // Theme side term link
+    } else {
+        $retval = bbp_get_user_profile_link( $user_id );
+    }
+
+    return $retval;
+}
+
 /** Permissions ***************************************************************/