Changeset 6583 for trunk/src/includes/common/functions.php

Timestamp:

06/19/2017 04:29:43 AM (7 years ago)

Author:

johnjamesjacoby

Message:

Better 404 handling:

• Introduce bbp_is_404 query var, and set this in places where the default 404 condition needs to be overridden
• Introduce bbp_set_200() for cases where a default of 404 needs to be set to a 200
• Introduce bbp_get_wp_query() helper for getting the $wp_query global
• Update bbp_set_404() to accept a $query parameter to make passing the query around easier
• Update child-ids queries to use the last_changed cache to reduce the amount of cache churn when cleaning

Fixes #3047. See #1973.

File:

• trunk/src/includes/common/functions.php (modified) (5 diffs)

trunk/src/includes/common/functions.php

@@ -93 +93 @@
  */
 function bbp_get_paged() {
-    global $wp_query;
+    $wp_query = bbp_get_wp_query();
 
     // Check the query var
@@ -1567 +1567 @@
 
     $query = new WP_Query( array(
-        'fields'      => 'ids',
-        'post_parent' => $parent_id,
-        'post_status' => $post_status,
-        'post_type'   => $post_type,
+        'fields'           => 'ids',
+        'suppress_filters' => true,
+        'post_parent'      => $parent_id,
+        'post_status'      => $post_status,
+        'post_type'        => $post_type,
+        'posts_per_page'   => -1,
 
         // Maybe change these later
-        'posts_per_page'         => -1,
         'update_post_term_cache' => false,
         'update_post_meta_cache' => false,
         'ignore_sticky_posts'    => true,
-        'no_found_rows'          => true
+        'no_found_rows'          => true,
+        'nopaging'               => true
     ) );
     $child_ids = ! empty( $query->posts ) ? $query->posts : array();
@@ -1603 +1605 @@
     }
 
-    // The ID of the cached query
-    $cache_id  = 'bbp_parent_all_' . $parent_id . '_type_' . $post_type . '_child_ids';
+    // Check cache key
+    $key          = md5( serialize( array( 'parent_id' => $parent_id, 'post_type' => $post_type ) ) );
+    $last_changed = wp_cache_get_last_changed( 'bbpress_posts' );
+    $cache_key    = "bbp_child_ids:{$key}:{$last_changed}";
 
     // Check for cache and set if needed
-    $child_ids = wp_cache_get( $cache_id, 'bbpress_posts' );
+    $child_ids = wp_cache_get( $cache_key, 'bbpress_posts' );
     if ( false === $child_ids ) {
         $post_status = array( bbp_get_public_status_id() );
@@ -1645 +1649 @@
 
         // Always cache the results
-        wp_cache_set( $cache_id, $child_ids, 'bbpress_posts' );
+        wp_cache_set( $cache_key, $child_ids, 'bbpress_posts' );
     }
 
@@ -2016 +2020 @@
  *
  * @since 2.0.0 bbPress (r3051)
- *
- * @global WP_Query $wp_query
- */
-function bbp_set_404() {
-    global $wp_query;
-
-    if ( ! isset( $wp_query ) ) {
-        _doing_it_wrong( __FUNCTION__, esc_html__( 'Conditional query tags do not work before the query is run. Before then, they always return false.', 'bbpress' ), '3.1' );
-        return false;
-    }
-
-    $wp_query->set_404();
-}
-
-/**
- * Maybe avoid default 404 handling for some bbPress pages
+ * @since 2.6.0 bbPress (r6583) Use status_header() & nocache_headers()
+ *
+ * @param WP_Query $query  The query being checked
+ *
+ * @return bool Always returns true
+ */
+function bbp_set_404( $query = null ) {
+
+    // Global fallback
+    if ( empty( $query ) ) {
+        $query = bbp_get_wp_query();
+    }
+
+    // Setup environment
+    $query->set_404();
+
+    // Setup request
+    status_header( 404 );
+    nocache_headers();
+}
+
+/**
+ * Sets the 200 status header.
+ *
+ * @since 2.6.0 bbPress (r6583)
+ */
+function bbp_set_200() {
+    status_header( 200 );
+}
+
+/**
+ * Maybe handle the default 404 handling for some bbPress conditions
+ *
+ * Some conditions (like private/hidden forums and edits) have their own checks
+ * on `bbp_template_redirect` and are not currently 404s.
  *
  * @since 2.6.0 bbPress (r6555)
+ *
+ * @param bool $override Whether to override the default handler
+ * @param WP_Query $wp_query The posts query being referenced
+ *
+ * @return bool False to leave alone, true to override
  */
 function bbp_pre_handle_404( $override = false, $wp_query = false ) {
+
+    // Handle a bbPress 404 condition
+    if ( isset( $wp_query->bbp_is_404 ) ) {
+
+        // Either force a 404 when 200, or a 200 when 404
+        $override = ( true === $wp_query->bbp_is_404 )
+            ? bbp_set_404( $wp_query )
+            : bbp_set_200();
+    }
+
     return $override;
 }
+
+/**
+ * Maybe pre-assign the posts that are returned from a WP_Query.
+ *
+ * This effectively short-circuits the default query for posts, which is
+ * currently only used to avoid calling the main query when it's not necessary.
+ *
+ * @since 2.6.0 bbPress (r6580)
+ *
+ * @param mixed $posts Default null. Array of posts (possibly empty)
+ * @param WP_Query $wp_query
+ *
+ * @return mixed Null if no override. Array if overridden.
+ */
+function bbp_posts_pre_query( $posts = null, $wp_query = false ) {
+
+    // Custom 404 handler is set, so set posts to empty array to avoid 2 queries
+    if ( isset( $wp_query->bbp_is_404 ) ) {
+        $posts = array();
+    }
+
+    // Return, maybe overridden
+    return $posts;
+}