Changeset 6628

Timestamp:

07/19/2017 05:02:30 PM (8 years ago)

Author:

johnjamesjacoby

Message:

Separators: Normalize the sep arguments between functions.

This change also switches bbp_list_forums() to implode() links rather than concatenate the same $output string with an increasing number of items. This has the positive side-effect of moving the forum separator (a comma by default) out of individual links.

Props milindmore22. Fixes #2900.

Location:

trunk/src/includes

Files:

• admin/tools/common.php (modified) (4 diffs)
• forums/template.php (modified) (1 diff)

trunk/src/includes/admin/tools/common.php

@@ -442 +442 @@
     // Parse args
     $r = bbp_parse_args( $args, array(
-        'before'            => '<ul class="subsubsub">',
-        'after'             => '</ul>',
-        'link_before'       => '<li>',
-        'link_after'        => '</li>',
-        'count_before'      => ' <span class="count">(',
-        'count_after'       => ')</span>',
-        'separator'         => ' | ',
+        'before'       => '<ul class="subsubsub">',
+        'after'        => '</ul>',
+        'link_before'  => '<li>',
+        'link_after'   => '</li>',
+        'count_before' => ' <span class="count">(',
+        'count_after'  => ')</span>',
+        'sep'          => ' | ',
+
+        // Retired, use 'sep' instead
+        'separator'    => false
     ), 'get_admin_repair_tool_overhead_filters' );
+
+    /**
+     * Necessary for backwards compatibility
+     * @see https://bbpress.trac.wordpress.org/ticket/2900
+     */
+    if ( ! empty( $r['separator'] ) ) {
+        $r['sep'] = $r['separator'];
+    }
 
     // Get page
@@ -480 +491 @@
     // Create the "All" link
     $current = empty( $_GET['overhead'] ) ? 'current' : '';
-    $links[] = $r['link_before']. '<a href="' . esc_url( $tools_url ) . '" class="' . esc_attr( $current ) . '">' . sprintf( esc_html__( 'All %s', 'bbpress' ), $r['count_before'] . count( $tools ) . $r['count_after'] ) . '</a>' . $r['link_after'];
-
-    // Default ticker
-    $i = 0;
+    $links[] = $r['link_before'] . '<a href="' . esc_url( $tools_url ) . '" class="' . esc_attr( $current ) . '">' . sprintf( esc_html__( 'All %s', 'bbpress' ), $r['count_before'] . count( $tools ) . $r['count_after'] ) . '</a>' . $r['link_after'];
 
     // Sort
@@ -490 +498 @@
     // Loop through overheads and build filter
     foreach ( $overheads as $overhead => $count ) {
-
-        // Separator count
-        $i++;
 
         // Build the filter URL
@@ -514 +519 @@
 
     // Surround output with before & after strings
-    $output = $r['before'] . implode( $r['separator'], $links ) . $r['after'];
+    $output = $r['before'] . implode( $r['sep'], $links ) . $r['after'];
 
     // Filter & return

trunk/src/includes/forums/template.php

@@ -673 +673 @@
 function bbp_list_forums( $args = array() ) {
 
-    // Define used variables
-    $output = '';
-
     // Parse arguments against default values
     $r = bbp_parse_args( $args, array(
-        'before'            => '<ul class="bbp-forums-list">',
-        'after'             => '</ul>',
-        'link_before'       => '<li class="bbp-forum">',
-        'link_after'        => '</li>',
-        'count_before'      => ' (',
-        'count_after'       => ')',
-        'count_sep'         => ', ',
-        'separator'         => ', ',
-        'forum_id'          => '',
-        'show_topic_count'  => true,
-        'show_reply_count'  => true,
+        'before'           => '<ul class="bbp-forums-list">',
+        'after'            => '</ul>',
+        'link_before'      => '<li class="bbp-forum">',
+        'link_after'       => '</li>',
+        'count_before'     => ' (',
+        'count_after'      => ')',
+        'count_sep'        => ', ',
+        'sep'              => ', ',
+        'forum_id'         => '',
+        'show_topic_count' => true,
+        'show_reply_count' => true,
+
+        // Retired, use 'sep' instead
+        'separator'        => false
     ), 'list_forums' );
+
+    /**
+     * Necessary for backwards compatibility
+     * @see https://bbpress.trac.wordpress.org/ticket/2900
+     */
+    if ( ! empty( $r['separator'] ) ) {
+        $r['sep'] = $r['separator'];
+    }
+
+    // Define links
+    $links = array();
 
     // Loop through forums and create a list
     $sub_forums = bbp_forum_get_subforums( $r['forum_id'] );
-    if ( ! empty( $sub_forums ) ) {
-
-        // Total count (for separator)
-        $i          = 0;
-        $total_subs = count( $sub_forums );
-
-        foreach ( $sub_forums as $sub_forum ) {
-            $i++; // Separator count
-
-            // Get forum details
-            $count     = array();
-            $permalink = bbp_get_forum_permalink( $sub_forum->ID );
-            $title     = bbp_get_forum_title( $sub_forum->ID );
-            $show_sep  = ( $total_subs > $i )
-                ? $r['separator']
-                : '';
-
-            // Show topic count
-            if ( ! empty( $r['show_topic_count'] ) && ! bbp_is_forum_category( $sub_forum->ID ) ) {
-                $count['topic'] = bbp_get_forum_topic_count( $sub_forum->ID );
-            }
-
-            // Show reply count
-            if ( ! empty( $r['show_reply_count'] ) && ! bbp_is_forum_category( $sub_forum->ID ) ) {
-                $count['reply'] = bbp_get_forum_reply_count( $sub_forum->ID );
-            }
-
-            // Counts to show
-            $counts = ! empty( $count )
-                ? $r['count_before'] . implode( $r['count_sep'], $count ) . $r['count_after']
-                : '';
-
-            // Subforum classes
-            $subforum_classes      = array( 'bbp-forum-link' );
-            $subforum_classes      = apply_filters( 'bbp_list_forums_subforum_classes', $subforum_classes, $sub_forum->ID );
-            $subforum_classes_attr = 'class="' . implode( ' ', array_map( 'esc_attr', $subforum_classes ) ) . '"';
-
-            // Build this sub forums link
-            $output .= $r['link_before'] . '<a href="' . esc_url( $permalink ) . '" ' . $subforum_classes_attr . '>' . $title . $counts . '</a>' . $show_sep . $r['link_after'];
-        }
+    foreach ( $sub_forums as $sub_forum ) {
+
+        // Get forum details
+        $count     = array();
+        $permalink = bbp_get_forum_permalink( $sub_forum->ID );
+        $title     = bbp_get_forum_title( $sub_forum->ID );
+
+        // Show topic count
+        if ( ! empty( $r['show_topic_count'] ) && ! bbp_is_forum_category( $sub_forum->ID ) ) {
+            $count['topic'] = bbp_get_forum_topic_count( $sub_forum->ID );
+        }
+
+        // Show reply count
+        if ( ! empty( $r['show_reply_count'] ) && ! bbp_is_forum_category( $sub_forum->ID ) ) {
+            $count['reply'] = bbp_get_forum_reply_count( $sub_forum->ID );
+        }
+
+        // Counts to show
+        $counts = ! empty( $count )
+            ? $r['count_before'] . implode( $r['count_sep'], $count ) . $r['count_after']
+            : '';
+
+        // Subforum classes
+        $subforum_classes      = array( 'bbp-forum-link' );
+        $subforum_classes      = apply_filters( 'bbp_list_forums_subforum_classes', $subforum_classes, $sub_forum->ID );
+        $subforum_classes_attr = 'class="' . implode( ' ', array_map( 'esc_attr', $subforum_classes ) ) . '"';
+
+        // Build this sub forums link
+        $links[] = $r['link_before'] . '<a href="' . esc_url( $permalink ) . '" ' . $subforum_classes_attr . '>' . $title . $counts . '</a>' . $r['link_after'];
     }
 
     // Maybe wrap output
-    if ( ! empty( $output ) ) {
-        $output = $r['before'] . $output . $r['after'];
-    }
+    $output = ! empty( $links )
+        ? $r['before'] . implode( $r['sep'], $links ) . $r['after']
+        : '';
 
     // Filter & output the forums list