Changeset 6414

Timestamp:

05/19/2017 02:44:11 AM (8 years ago)

Author:

johnjamesjacoby

Message:

Forums: Audit private/hidden forum ID exclusion:

• improve performance of bbp_exclude_forum_ids()
• Use bbp_exclude_forum_ids() where duplicate code existed
• Make sure $forum_ids are passed into bbp_exclude_forum_ids filter
• Prefer arrays over imploded strings (also with post statuses)

Location:

trunk/src/includes

Files:

• core/cache.php (modified) (1 diff)
• forums/functions.php (modified) (4 diffs)
• forums/template.php (modified) (1 diff)
• replies/template.php (modified) (1 diff)
• search/template.php (modified) (1 diff)
• topics/template.php (modified) (1 diff)
• users/template.php (modified) (2 diffs)

trunk/src/includes/core/cache.php

@@ -181 +181 @@
     // Loop through query types and clean caches
     foreach ( $post_types as $post_type ) {
-        wp_cache_delete( 'bbp_parent_all_' . $post->ID . '_type_' . $post_type . '_child_ids', 'bbpress_posts' );
-    }
-
-    /**
-     * Fires immediately after the given post's cache is cleaned.
+        $key = 'bbp_parent_all_' . $post->ID . '_type_' . $post_type . '_child_ids';
+        wp_cache_delete( $key, 'bbpress_posts' );
+    }
+
+    /**
+     * Fires immediately after the given post cache is cleaned.
      *
      * @since 2.1.0

trunk/src/includes/forums/functions.php

@@ -2090 +2090 @@
 
     // Setup arrays
-    $private = $hidden = $meta_query = $forum_ids = array();
+    $forum_ids = array();
 
     // Capability performance optimization
     if ( ! empty( $types[ $type ] ) ) {
-        $retval = $types[ $type ];
-
-    // Populate forum exclude type
+        $retval    = $types[ $type ];
+        $forum_ids = $types['array'];
+
+    // Populate forum types
     } else {
 
-        // Default return value
-        switch ( $type ) {
-            case 'string' :
-                $retval = '';
-                break;
-
-            case 'array'  :
-                $retval = array();
-                break;
-
-            case 'meta_query' :
-                $retval = array( array() ) ;
-                break;
-        }
+        // Types
+        $types = array(
+            'array'      => array(),
+            'string'     => '',
+            'meta_query' => array()
+        );
 
         // Exclude for everyone but keymasters
@@ -2118 +2111 @@
 
             // Private forums
-            if ( ! current_user_can( 'read_private_forums' ) ) {
-                $private = bbp_get_private_forum_ids();
+            $private = ! current_user_can( 'read_private_forums' )
+                ? bbp_get_private_forum_ids()
+                : array();
+
+            // Hidden forums
+            $hidden = ! current_user_can( 'read_hidden_forums' )
+                ? bbp_get_hidden_forum_ids()
+                : array();
+
+            // Merge private and hidden forums together and remove any empties
+            $forum_ids = ( ! empty( $private ) || ! empty( $hidden ) )
+                ? array_filter( wp_parse_id_list( array_merge( $private, $hidden ) ) )
+                : array();
+
+            // Comparison
+            $compare = ( 1 < count( $forum_ids ) )
+                ? 'NOT IN'
+                : '!=';
+
+            // Store return values in static types array
+            if ( ! empty( $forum_ids ) ) {
+                $types['array']      = $forum_ids;
+                $types['string']     = implode( ',', $forum_ids );
+                $types['meta_query'] = array(
+                    'key'     => '_bbp_forum_id',
+                    'value'   => $forum_ids,
+                    'type'    => 'NUMERIC',
+                    'compare' => $compare
+                );
             }
-
-            // Hidden forums
-            if ( ! current_user_can( 'read_hidden_forums' ) ) {
-                $hidden  = bbp_get_hidden_forum_ids();
-            }
-
-            // Merge private and hidden forums together
-            $forum_ids = (array) array_filter( wp_parse_id_list( array_merge( $private, $hidden ) ) );
-
-            // There are forums that need to be excluded
-            if ( ! empty( $forum_ids ) ) {
-
-                switch ( $type ) {
-
-                    // Separate forum ID's into a comma separated string
-                    case 'string' :
-                        $retval = implode( ',', $forum_ids );
-                        break;
-
-                    // Use forum_ids array
-                    case 'array'  :
-                        $retval = $forum_ids;
-                        break;
-
-                    // Build a meta_query
-                    case 'meta_query' :
-                        $retval = array(
-                            'key'     => '_bbp_forum_id',
-                            'value'   => implode( ',', $forum_ids ),
-                            'type'    => 'NUMERIC',
-                            'compare' => ( 1 < count( $forum_ids ) ) ? 'NOT IN' : '!='
-                        );
-                        break;
-                }
-            }
-        }
-
-        // Store return value in static types array
-        $types[ $type ] = $retval;
+        }
+
+        // There are forums that need to be excluded
+        $retval = $types[ $type ];
     }
 
@@ -2260 +2245 @@
 
         // Bail if no forums to exclude
-        if ( ! array_filter( $forum_ids ) ) {
+        if ( empty( $forum_ids ) ) {
             return;
         }
@@ -2570 +2555 @@
 
     // Allowed post statuses to pre-trash
-    $post_stati = implode( ',', array(
+    $post_stati = array(
         bbp_get_public_status_id(),
         bbp_get_closed_status_id(),
         bbp_get_pending_status_id()
-    ) );
+    );
 
     // Forum is being trashed, so its topics and replies are trashed too

trunk/src/includes/forums/template.php

@@ -722 +722 @@
         'post_parent'         => 0,
         'post_type'           => bbp_get_forum_post_type(),
-        'post_status'         => implode( ',', $post_stati ),
+        'post_status'         => $post_stati,
         'posts_per_page'      => get_option( '_bbp_forums_per_page', 50 ),
         'orderby'             => 'menu_order title',

trunk/src/includes/replies/template.php

@@ -168 +168 @@
 
         // Join post statuses together
-        $default['post_status'] = implode( ',', $post_statuses );
+        $default['post_status'] = $post_statuses;
 
     // Lean on the 'perm' query var value of 'readable' to provide statuses

trunk/src/includes/search/template.php

@@ -80 +80 @@
 
         // Join post statuses together
-        $default['post_status'] = implode( ',', $post_statuses );
+        $default['post_status'] = $post_statuses;
 
     // Lean on the 'perm' query var value of 'readable' to provide statuses

trunk/src/includes/topics/template.php

@@ -184 +184 @@
 
         // Join post statuses together
-        $default['post_status'] = implode( ',', $post_statuses );
+        $default['post_status'] = $post_statuses;
 
     // Lean on the 'perm' query var value of 'readable' to provide statuses

trunk/src/includes/users/template.php

@@ -2287 +2287 @@
 function bbp_get_forums_for_current_user( $args = array() ) {
 
-    // Setup arrays
-    $private = $hidden = $exclude = array();
-
-    // Private forums
-    if ( ! current_user_can( 'read_private_forums' ) ) {
-        $private = bbp_get_private_forum_ids();
-    }
-
-    // Hidden forums
-    if ( ! current_user_can( 'read_hidden_forums' ) ) {
-        $hidden  = bbp_get_hidden_forum_ids();
-    }
-
-    // Merge private and hidden forums together and remove any empties
-    $forum_ids = (array) array_filter( wp_parse_id_list( array_merge( $private, $hidden ) ) );
-
-    // There are forums that need to be excluded
-    if ( ! empty( $forum_ids ) ) {
-        $exclude = implode( ',', $forum_ids );
-    }
-
     // Parse arguments against default values
     $r = bbp_parse_args( $args, array(
-        'post_type'   => bbp_get_forum_post_type(),
-        'post_status' => bbp_get_public_status_id(),
-        'numberposts' => -1,
-        'exclude'     => $exclude
+        'post_type'    => bbp_get_forum_post_type(),
+        'post_status'  => bbp_get_public_status_id(),
+        'post__not_in' => bbp_exclude_forum_ids( 'array' ),
+        'numberposts'  => -1
     ), 'get_forums_for_current_user' );
 
@@ -2324 +2303 @@
     }
 
-    return apply_filters( 'bbp_get_forums_for_current_user', $forums );
+    return apply_filters( 'bbp_get_forums_for_current_user', $forums, $r, $args );
 }