Changeset 7262

Timestamp:

06/28/2024 06:06:30 PM (8 months ago)

Author:

johnjamesjacoby

Message:

Search: prevent hidden forums from appearing in results.

This change includes the following changes:

• Removes readable perm check from bbp_has_search_results() and replaces it with public topic statuses by default, while conditionally adding private & hidden statuses if user is capable
• Tweaks the logic inside of bbp_pre_get_posts_normalize_forum_visibility() to always handle both of its internal conditions (forum query, or any query that includes forums/topics/replies connected via meta data)
• Tweaks output of content-search.php template part to not show the "Oh bother" error when visiting a search page for the first time
• Adds a string feedback-no-search.php template part to address both "no results" and "no terms" conditions

These changes address some faulty search logic that was allowing hidden forums to appear in global search results to users who should not have been able to see them, while also improving the search page experience itself.

Fixes #3473.

Props wpsolr, robin-w.

In branches/2.6, for 2.6.10.

Location:

branches/2.6/src

Files:

• includes/forums/functions.php (modified) (2 diffs)
• includes/search/template.php (modified) (1 diff)
• templates/default/bbpress/content-search.php (modified) (2 diffs)
• templates/default/bbpress/feedback-no-search.php (modified) (2 diffs)

branches/2.6/src/includes/forums/functions.php

@@ -2309 +2309 @@
     }
 
-    // Get query post types array .
-    $post_types = (array) $posts_query->get( 'post_type' );
+    // Bail to prevent unintended wp-admin post_row overrides
+    if ( is_admin() && isset( $_REQUEST['post_status'] ) ) {
+        return;
+    }
+
+    // Get query post types as an array.
+    $post_types = array_filter( (array) $posts_query->get( 'post_type' ) );
 
     // Forums
-    if ( bbp_get_forum_post_type() === implode( '', $post_types ) ) {
-
-        // Prevent accidental wp-admin post_row override
-        if ( is_admin() && isset( $_REQUEST['post_status'] ) ) {
-            return;
-        }
+    if ( in_array( bbp_get_forum_post_type(), $post_types, true ) ) {
 
         /** Default ***********************************************************/
@@ -2326 +2326 @@
 
         // Get forums to exclude
-        $hidden_ids = bbp_exclude_forum_ids( 'array' );
-
-        // Bail if no forums to exclude
-        if ( empty( $hidden_ids ) ) {
-            return;
-        }
-
-        // Get any existing meta queries
-        $not_in = $posts_query->get( 'post__not_in', array() );
-
-        // Add our meta query to existing
-        $not_in = array_unique( array_merge( $not_in, $hidden_ids ) );
-
-        // Set the meta_query var
-        $posts_query->set( 'post__not_in', $not_in );
+        $forum_ids = bbp_exclude_forum_ids( 'array' );
+
+        // Excluding some forums
+        if ( ! empty( $forum_ids ) ) {
+
+            // Get any existing not-in queries
+            $not_in = $posts_query->get( 'post__not_in', array() );
+
+            // Add our not-in to existing
+            $not_in = array_unique( array_merge( $not_in, $forum_ids ) );
+
+            // Set the new not-in val
+            $posts_query->set( 'post__not_in', $not_in );
+        }
+    }
 
     // Some other post type besides Forums, Topics, or Replies
-    } elseif ( ! array_diff( $post_types, bbp_get_post_types() ) ) {
+    if ( ! array_diff( $post_types, bbp_get_post_types() ) ) {
 
         // Get forums to exclude
         $forum_ids = bbp_exclude_forum_ids( 'meta_query' );
 
-        // Bail if no forums to exclude
-        if ( empty( $forum_ids ) ) {
-            return;
-        }
-
-        // Get any existing meta queries
-        $meta_query   = (array) $posts_query->get( 'meta_query', array() );
-
-        // Add our meta query to existing
-        $meta_query[] = $forum_ids;
-
-        // Set the meta_query var
-        $posts_query->set( 'meta_query', $meta_query );
+        // Excluding some forums
+        if ( ! empty( $forum_ids ) ) {
+
+            // Get any existing meta queries
+            $meta_query   = (array) $posts_query->get( 'meta_query', array() );
+
+            // Add our meta query to existing
+            $meta_query[] = $forum_ids;
+
+            // Set the new meta_query val
+            $posts_query->set( 'meta_query', $meta_query );
+        }
     }
 }

branches/2.6/src/includes/search/template.php

@@ -47 +47 @@
     }
 
-    // What are the default allowed statuses (based on user caps)
-    if ( bbp_get_view_all() ) {
-
-        // Default view=all statuses
-        $post_statuses = array_keys( bbp_get_topic_statuses() );
-
-        // Add support for private status
-        if ( current_user_can( 'read_private_topics' ) ) {
-            $post_statuses[] = bbp_get_private_status_id();
-        }
-
-        // Join post statuses together
-        $default['post_status'] = $post_statuses;
-
-    // Lean on the 'perm' query var value of 'readable' to provide statuses
-    } else {
-        $default['perm'] = 'readable';
-    }
+    // Default public statuses (topics coincidentally cover all post types)
+    $post_statuses = array_keys( bbp_get_public_topic_statuses() );
+
+    // Add support for private status
+    if ( current_user_can( 'read_private_topics' ) ) {
+        $post_statuses[] = bbp_get_private_status_id();
+    }
+
+    // Add support for hidden status
+    if ( current_user_can( 'read_hidden_topics' ) ) {
+        $post_statuses[] = bbp_get_hidden_status_id();
+    }
+
+    // Join post statuses together
+    $default['post_status'] = $post_statuses;
 
     /** Setup *****************************************************************/

branches/2.6/src/templates/default/bbpress/content-search.php

@@ -15 +15 @@
 <div id="bbpress-forums" class="bbpress-wrapper">
 
+    <?php bbp_get_template_part( 'form', 'search' ); ?>
+
     <?php bbp_breadcrumb(); ?>
 
@@ -29 +31 @@
         <?php bbp_get_template_part( 'pagination', 'search' ); ?>
 
-    <?php elseif ( bbp_get_search_terms() ) : ?>
+    <?php else : ?>
 
         <?php bbp_get_template_part( 'feedback',   'no-search' ); ?>
-
-    <?php else : ?>
-
-        <?php bbp_get_template_part( 'form', 'search' ); ?>
 
     <?php endif; ?>

branches/2.6/src/templates/default/bbpress/feedback-no-search.php

@@ -11 +11 @@
 defined( 'ABSPATH' ) || exit;
 
-?>
+if ( bbp_get_search_terms() ) : ?>
 
 <div class="bbp-template-notice">
@@ -18 +18 @@
     </ul>
 </div>
+
+<?php else : ?>
+
+<div class="bbp-template-notice">
+    <ul>
+        <li><?php esc_html_e( 'Please enter some search terms.', 'bbpress' ); ?></li>
+    </ul>
+</div>
+
+<?php endif;