Changeset 4138

Timestamp:

09/27/2016 05:56:20 PM (8 years ago)

Author:

coffee2code

Message:

Support Forums: Add moderator badge to moderator forum replies.

• Keymasters get the same "Moderator" badge as there is no need to publicly differentiate the roles.
• The badge color matches the color used for the support team's profiles.wordpress.org badges.
• In contexts where the user would otherwise get a plugin or theme author/contributor badge, the moderator badge is not shown.

See #2073.

Location:

sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-bbp-user-badges

Files:

• inc/class-plugin.php (modified) (5 diffs)
• wporg-bbp-user-badges.php (modified) (1 diff)

sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-bbp-user-badges/inc/class-plugin.php

@@ -55 +55 @@
 
         // Add badge before reply author info.
-        add_action( 'bbp_theme_before_reply_author_details', array( $this, 'wporg_support_add_author_badges' ) );
+        add_action( 'bbp_theme_before_reply_author_details', array( $this, 'add_user_badges' ) );
     }
 
@@ -103 +103 @@
 
     public function bbp_get_reply_class( $classes, $reply_id ) {
+        // Class related to moderators.
+        if ( $this->is_user_moderator() ) {
+            $classes[] = 'by-moderator';
+        }
+
         // Class related to plugin and theme authors/contributors.
         if ( $info = $this->get_author_badge_info() ) {
@@ -125 +130 @@
      * the plugin/theme they contribute to.
      */
-    public function wporg_support_add_author_badges() {
+    public function add_user_badges() {
+        $output = $this->get_author_badge();
+
+        // Don't assign moderator badge if already assigning author badge.
+        if ( ! $output ) {
+            $output = $this->get_moderator_badge();
+        }
+
+        if ( $output ) {
+            echo $this->format_badge( $output['type'], $output['label'], $output['help'] );
+        }
+    }
+
+    protected function format_badge( $type, $label, $help = '' ) {
+        $output = '';
+
+        if ( $label ) {
+            $output .= sprintf(
+                '<span class="author-badge author-badge-%s" title="%s">%s</span>',
+                esc_attr( $type ),
+                esc_attr( $help ),
+                $label
+            );
+        }
+
+        // Return the markup.
+        return $output;
+    }
+
+    protected function get_author_badge() {
         if ( ! $info = $this->get_author_badge_info() ) {
             return;
@@ -152 +186 @@
         }
 
-        // Build the markup.
-        $output = '';
-        if ( $label ) {
-            $output .= sprintf(
-                '<span class="author-badge %s-author-badge" title="%s">%s</span>',
-                esc_attr( $info['type'] ),
-                esc_attr( $help ),
-                $label
-            );
-        }
-
-        // Output the markup.
-        echo $output;
+        return $label ? array( 'type' => $info['type'], 'label' => $label, 'help' => $help ) : false;
+    }
+
+    protected function get_moderator_badge() {
+        $label = $help = null;
+
+        if ( $this->is_user_moderator() ) {
+            $label = __( 'Moderator', 'wporg-forums' );
+            $help  = __( 'This person is a moderator on this forum', 'wporg-forums' );
+        }
+
+        return $label ? array( 'type' => 'moderator', 'label' => $label, 'help' => $help ) : false;
     }
 
@@ -251 +284 @@
     }
 
+    /**
+     * Checks if the specified user is a forum moderator or keymaster.
+     *
+     * By default, this considers a keymaster as being a moderator for the purpose
+     * of badging them. Use the $strict argument to check that the user is a
+     * moderator without considering if they are a keymaster.
+     *
+     * @param string $user_id Optional. User ID. Assumes current reply author ID
+     *                        if not provided.
+     * @param bool   $strict  Optional. True if user should strictly be checked
+     *                        for being a moderator, false will also check if they
+     *                        are a keymaster. Default false.
+     * @return bool           True if user is a moderator, false otherwise.
+     */
+    public function is_user_moderator( $user_id = '', $strict = false ) {
+        if ( ! $user_id ) {
+            $user_id = bbp_get_reply_author_id();
+        }
+
+        return ( user_can( $user_id, 'moderate' ) || ( ! $strict && bbp_is_user_keymaster( $user_id ) ) );
+    }
 }

sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-bbp-user-badges/wporg-bbp-user-badges.php

@@ -1 +1 @@
 <?php
 /**
- * Plugin Name: bbPress: Show User Badges
- * Description: Display a badge for plugin and theme authors and contributors for replies in their own support forums.
+ * Plugin Name: bbPress: User Badges
+ * Description: Display a badge in user replies as appropriate (such as for a plugin/theme author/contributor, moderator).
  * Version:     1.0
  * Author:      WordPress.org