Changeset 5835

Timestamp:

07/15/2015 04:30:34 PM (10 years ago)

Author:

johnjamesjacoby

Message:

Moderators: Introduce none argument for topic-tags & forum-mods list functions.

This change allows for passing text or HTML to output if no taxonomy terms are found, and uses this new functionality in wp-admin to show per-forum moderators in the list-table column, also reducing code duplication.

See #459.

Location:

trunk/src/includes

Files:

• admin/forums.php (modified) (1 diff)
• forums/template.php (modified) (4 diffs)
• topics/template.php (modified) (5 diffs)

trunk/src/includes/admin/forums.php

@@ -696 +696 @@
 
             case 'bbp_forum_mods' :
-                $moderators = wp_get_object_terms( $forum_id, bbp_get_forum_mod_tax_id() );
-                if ( empty( $moderators ) ) {
-                    esc_html__( 'None', 'bbpress' );
-                } else {
-                    echo implode( ', ', wp_list_pluck( $moderators, 'name' ) );
-                }
+                bbp_forum_mod_list( $forum_id, array(
+                    'before' => '',
+                    'after'  => '',
+                    'none'   => esc_html__( '—', 'bbpress' )
+                ) );
                 break;
 

trunk/src/includes/forums/template.php

@@ -2231 +2231 @@
  * Output a the moderators of a forum
  *
+ * @since bbPress (r5834)
+ *
  * @param int   $forum_id Optional. Topic id
  * @param array $args     See {@link bbp_get_forum_mod_list()}
@@ -2240 +2242 @@
     /**
      * Return the moderators of a forum
+     *
+     * @since bbPress (r5834)
      *
      * @param int   $forum_id Optional. Forum id
@@ -2255 +2259 @@
         // Bail if forum-mods are off
         if ( ! bbp_allow_forum_mods() ) {
-            return;
+            return '';
         }
 
@@ -2262 +2266 @@
             'before' => '<div class="bbp-forum-mods"><p>' . esc_html__( 'Moderators:', 'bbpress' ) . '&nbsp;',
             'sep'    => ', ',
-            'after'  => '</p></div>'
+            'after'  => '</p></div>',
+            'none'   => ''
         ), 'get_forum_mod_list' );
 
+        // Bail if forum ID is invalid
         $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'] );
+        if ( empty( $forum_id ) ) {
+            return '';
+        }
+
+        // Get forum moderators
+        $moderators = wp_get_object_terms( $forum_id, bbp_get_forum_mod_tax_id() );
+        if ( ! empty( $moderators ) ) {
+
+            // In admin, use nicenames
+            if ( is_admin() ) {
+
+                // @todo link to filtering forums by moderator
+                $users = wp_list_pluck( $moderators, 'name' );
+
+            // In theme, use display names & profile links
+            } else {
+                $users    = array();
+                $term_ids = wp_list_pluck( $moderators, 'term_id' );
+                foreach ( $term_ids as $term_id ) {
+                    $user_id = bbp_get_term_taxonomy_user_id( $term_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 $retval;

trunk/src/includes/topics/template.php

@@ -2358 +2358 @@
  * Output a the tags of a topic
  *
+ * @since bbPress (r2688)
+ *
  * @param int $topic_id Optional. Topic id
  * @param array $args See {@link bbp_get_topic_tag_list()}
@@ -2367 +2369 @@
     /**
      * Return the tags of a topic
+     *
+     * @since bbPress (r2688)
      *
      * @param int $topic_id Optional. Topic id
@@ -2381 +2385 @@
         // Bail if topic-tags are off
         if ( ! bbp_allow_topic_tags() ) {
-            return;
+            return '';
         }
 
@@ -2388 +2392 @@
             'before' => '<div class="bbp-topic-tags"><p>' . esc_html__( 'Tagged:', 'bbpress' ) . '&nbsp;',
             'sep'    => ', ',
-            'after'  => '</p></div>'
+            'after'  => '</p></div>',
+            'none'   => ''
         ), 'get_topic_tag_list' );
 
@@ -2399 +2404 @@
             $terms = get_post_meta( $topic_id, '_bbp_spam_topic_tags', true );
 
-            // If terms exist, explode them and compile the return value
+            // If terms exist, implode them and compile the return value
             if ( ! empty( $terms ) ) {
                 $terms  = implode( $r['sep'], $terms );
                 $retval = $r['before'] . $terms . $r['after'];
-
-            // No terms so return emty string
-            } else {
-                $retval = '';
             }
 
         // Topic is not spam so display a clickable term list
         } else {
-            $retval = get_the_term_list( $topic_id, bbp_get_topic_tag_tax_id(), $r['before'], $r['sep'], $r['after'] );
+            $terms = get_the_term_list( $topic_id, bbp_get_topic_tag_tax_id(), $r['before'], $r['sep'], $r['after'] );
+        }
+
+        // No terms so return none string
+        if ( empty( $terms ) ) {
+            $retval = $r['none'];
         }