Changeset 6922

Timestamp:

11/07/2019 07:40:16 PM (5 years ago)

Author:

johnjamesjacoby

Message:

Statuses: normalize status related functions across post types.

This commit adds 2 missing functions for forum statuses, and relocates all of them to the correct functions.php files for their post types.

Location:

trunk/src/includes

Files:

• common/functions.php (modified) (6 diffs)
• forums/functions.php (modified) (4 diffs)
• replies/functions.php (modified) (1 diff)
• replies/template.php (modified) (1 diff)
• topics/functions.php (modified) (2 diffs)
• topics/template.php (modified) (1 diff)

trunk/src/includes/common/functions.php

@@ -1869 +1869 @@
         // Forum
         case bbp_get_forum_post_type() :
-            $post_status = array( bbp_get_private_status_id(), bbp_get_hidden_status_id() );
+            $post_status = bbp_get_non_public_forum_statuses();
             break;
 
@@ -1879 +1879 @@
         // Reply
         case bbp_get_reply_post_type() :
+            $post_status = bbp_get_non_public_reply_statuses();
+            break;
+
+        // Any
         default :
-            $post_status = bbp_get_non_public_reply_statuses();
+            $post_status = bbp_get_public_status_id();
             break;
     }
@@ -1912 +1916 @@
     }
 
-    // Get the public post status
-    $post_status = array( bbp_get_public_status_id() );
-
-    // Add closed status if topic post type
-    if ( bbp_get_topic_post_type() === $post_type ) {
-        $post_status[] = bbp_get_closed_status_id();
+    // Which statuses
+    switch ( $post_type ) {
+
+        // Forum
+        case bbp_get_forum_post_type() :
+            $post_status = bbp_get_public_forum_statuses();
+            break;
+
+        // Topic
+        case bbp_get_topic_post_type() :
+            $post_status = bbp_get_public_topic_statuses();
+            break;
+
+        // Reply
+        case bbp_get_reply_post_type() :
+        default :
+            $post_status = bbp_get_public_reply_statuses();
+            break;
     }
 
@@ -1939 +1955 @@
         'no_found_rows'          => true
     ) );
-    $child_ids = ! empty( $query->posts ) ? $query->posts : array();
+
+    $child_ids = ! empty( $query->posts )
+        ? $query->posts
+        : array();
+
     unset( $query );
 
@@ -1963 +1983 @@
     }
 
-    // Check cache key
-    $key          = md5( serialize( array( 'parent_id' => $parent_id, 'post_type' => $post_type ) ) );
+    // Make cache key
+    $not_in = array( 'draft', 'future' );
+    $key    = md5( serialize( array(
+        'parent_id'   => $parent_id,
+        'post_type'   => $post_type,
+        'post_status' => $not_in
+    ) ) );
+
+    // Check last changed
     $last_changed = wp_cache_get_last_changed( 'bbpress_posts' );
     $cache_key    = "bbp_child_ids:{$key}:{$last_changed}";
@@ -1970 +1997 @@
     // Check for cache and set if needed
     $child_ids = wp_cache_get( $cache_key, 'bbpress_posts' );
+
+    // Not already cached
     if ( false === $child_ids ) {
 
         // Join post statuses to specifically exclude together
-        $not_in      = array( 'draft', 'future' );
         $post_status = "'" . implode( "', '", $not_in ) . "'";
         $bbp_db      = bbp_db();

trunk/src/includes/forums/functions.php

@@ -1822 +1822 @@
  * Return an associative array of available topic statuses
  *
+ * Developers note: these statuses are actually stored as meta data, and
+ * Visibilities are stored in post_status.
+ *
  * @since 2.4.0 bbPress (r5059)
  *
@@ -1857 +1860 @@
 /**
  * Return an associative array of forum visibility
+ *
+ * Developers note: these visibilities are actually stored in post_status, and
+ * Statuses are stored in meta data.
  *
  * @since 2.4.0 bbPress (r5059)
@@ -1872 +1878 @@
         bbp_get_hidden_status_id()  => _x( 'Hidden',  'Make forum hidden',  'bbpress' )
     ), $forum_id );
+}
+
+/**
+ * Return array of public forum statuses.
+ *
+ * @since 2.6.0 bbPress (r6921)
+ *
+ * @return array
+ */
+function bbp_get_public_forum_statuses() {
+    $statuses = array(
+        bbp_get_public_status_id()
+    );
+
+    // Filter & return
+    return (array) apply_filters( 'bbp_get_public_forum_statuses', $statuses );
+}
+
+/**
+ * Return array of non-public forum statuses.
+ *
+ * @since 2.6.0 bbPress (r6921)
+ *
+ * @return array
+ */
+function bbp_get_non_public_forum_statuses() {
+    $statuses = array(
+        bbp_get_private_status_id(),
+        bbp_get_hidden_status_id()
+    );
+
+    // Filter & return
+    return (array) apply_filters( 'bbp_get_non_public_forum_statuses', $statuses );
 }
 
@@ -2143 +2182 @@
         'no_found_rows'          => true
     ) );
+
     $reply_id = array_shift( $query->posts );
+
     unset( $query );
 

trunk/src/includes/replies/functions.php

@@ -1662 +1662 @@
 }
 
+/**
+ * Return array of public reply statuses.
+ *
+ * @since 2.6.0 bbPress (r6705)
+ *
+ * @return array
+ */
+function bbp_get_public_reply_statuses() {
+    $statuses = array(
+        bbp_get_public_status_id()
+    );
+
+    // Filter & return
+    return (array) apply_filters( 'bbp_get_public_reply_statuses', $statuses );
+}
+
+/**
+ * Return array of non-public reply statuses.
+ *
+ * @since 2.6.0 bbPress (r6791)
+ *
+ * @return array
+ */
+function bbp_get_non_public_reply_statuses() {
+    $statuses = array(
+        bbp_get_trash_status_id(),
+        bbp_get_spam_status_id(),
+        bbp_get_pending_status_id()
+    );
+
+    // Filter & return
+    return (array) apply_filters( 'bbp_get_non_public_reply_statuses', $statuses );
+}
+
 /** Reply Actions *************************************************************/
 

trunk/src/includes/replies/template.php

@@ -829 +829 @@
 
 /**
- * Return array of public reply statuses.
- *
- * @since 2.6.0 bbPress (r6705)
- *
- * @return array
- */
-function bbp_get_public_reply_statuses() {
-    $statuses = array(
-        bbp_get_public_status_id()
-    );
-
-    // Filter & return
-    return (array) apply_filters( 'bbp_get_public_reply_statuses', $statuses );
-}
-
-/**
- * Return array of non-public reply statuses.
- *
- * @since 2.6.0 bbPress (r6791)
- *
- * @return array
- */
-function bbp_get_non_public_reply_statuses() {
-    $statuses = array(
-        bbp_get_trash_status_id(),
-        bbp_get_spam_status_id(),
-        bbp_get_pending_status_id()
-    );
-
-    // Filter & return
-    return (array) apply_filters( 'bbp_get_non_public_reply_statuses', $statuses );
-}
-
-/**
  * Is the reply publicly viewable?
  *

trunk/src/includes/topics/functions.php

@@ -1900 +1900 @@
 }
 
+/**
+ * Return array of public topic statuses.
+ *
+ * @since 2.6.0 bbPress (r6383)
+ *
+ * @return array
+ */
+function bbp_get_public_topic_statuses() {
+    $statuses = array(
+        bbp_get_public_status_id(),
+        bbp_get_closed_status_id()
+    );
+
+    // Filter & return
+    return (array) apply_filters( 'bbp_get_public_topic_statuses', $statuses );
+}
+
+/**
+ * Return array of non-public topic statuses.
+ *
+ * @since 2.6.0 bbPress (r6642)
+ *
+ * @return array
+ */
+function bbp_get_non_public_topic_statuses() {
+    $statuses = array(
+        bbp_get_trash_status_id(),
+        bbp_get_spam_status_id(),
+        bbp_get_pending_status_id()
+    );
+
+    // Filter & return
+    return (array) apply_filters( 'bbp_get_non_public_topic_statuses', $statuses );
+}
+
 /** Stickies ******************************************************************/
 
@@ -3635 +3670 @@
 
     // Statuses to count
-    $object_statuses = array(
-        bbp_get_public_status_id(),
-        bbp_get_closed_status_id()
-    );
+    $object_statuses = bbp_get_public_topic_statuses();
 
     // Get database

trunk/src/includes/topics/template.php

@@ -1056 +1056 @@
 
 /**
- * Return array of public topic statuses.
- *
- * @since 2.6.0 bbPress (r6383)
- *
- * @return array
- */
-function bbp_get_public_topic_statuses() {
-    $statuses = array(
-        bbp_get_public_status_id(),
-        bbp_get_closed_status_id()
-    );
-
-    // Filter & return
-    return (array) apply_filters( 'bbp_get_public_topic_statuses', $statuses );
-}
-
-/**
- * Return array of non-public topic statuses.
- *
- * @since 2.6.0 bbPress (r6642)
- *
- * @return array
- */
-function bbp_get_non_public_topic_statuses() {
-    $statuses = array(
-        bbp_get_trash_status_id(),
-        bbp_get_spam_status_id(),
-        bbp_get_pending_status_id()
-    );
-
-    // Filter & return
-    return (array) apply_filters( 'bbp_get_non_public_topic_statuses', $statuses );
-}
-
-/**
  * Is the topic closed to new replies?
  *