Changeset 6438 for trunk/src/includes/forums/functions.php

Timestamp:

05/27/2017 05:04:31 PM (7 years ago)

Author:

johnjamesjacoby

Message:

Tools: Add //Filter & return note for future discovery of missing filter documentation.

Also adjust some type-casting on filtered results.

File:

• trunk/src/includes/forums/functions.php (modified) (21 diffs)

trunk/src/includes/forums/functions.php

@@ -83 +83 @@
     do_action( 'bbp_insert_forum', (int) $forum_id );
 
-    // Return new forum ID
+    // Return forum_id
     return $forum_id;
 }
@@ -1167 +1167 @@
     $forum_topic_count = (int) ( $total_topic_count + $difference );
 
+    // Filter & return
     return (int) apply_filters( 'bbp_bump_forum_topic_count', $forum_topic_count, $forum_id, $difference, $update_ancestors );
 }
@@ -1267 +1268 @@
     update_post_meta( $forum_id, '_bbp_topic_count_hidden', $new_count );
 
+    // Filter & return
     return (int) apply_filters( 'bbp_bump_forum_topic_count_hidden', $new_count, $forum_id, $difference );
 }
@@ -1385 +1387 @@
     $forum_reply_count = (int) ( $total_reply_count + $difference );
 
+    // Filter & return
     return (int) apply_filters( 'bbp_bump_forum_reply_count', $forum_reply_count, $forum_id, $difference, $update_ancestors );
 }
@@ -1554 +1557 @@
     }
 
+    // Filter & return
     return (int) apply_filters( 'bbp_update_forum_last_topic_id', $topic_id, $forum_id );
 }
@@ -1619 +1623 @@
     }
 
+    // Filter & return
     return (int) apply_filters( 'bbp_update_forum_last_reply_id', $reply_id, $forum_id );
 }
@@ -1686 +1691 @@
     }
 
+    // Filter & return
     return (int) apply_filters( 'bbp_update_forum_last_active_id', $active_id, $forum_id );
 }
@@ -1717 +1723 @@
     }
 
+    // Filter & return
     return apply_filters( 'bbp_update_forum_last_active', $new_time, $forum_id );
 }
@@ -1740 +1747 @@
     update_post_meta( $forum_id, '_bbp_forum_subforum_count', $subforums );
 
+    // Filter & return
     return (int) apply_filters( 'bbp_update_forum_subforum_count', $subforums, $forum_id );
 }
@@ -1784 +1792 @@
     update_post_meta( $forum_id, '_bbp_total_topic_count', $total_topics );
 
+    // Filter & return
     return (int) apply_filters( 'bbp_update_forum_topic_count', $total_topics, $forum_id );
 }
@@ -1849 +1858 @@
     }
 
+    // Filter & return
     return (int) apply_filters( 'bbp_update_forum_topic_count_hidden', $topic_count, $forum_id );
 }
@@ -1913 +1923 @@
     update_post_meta( $forum_id, '_bbp_total_reply_count', $total_replies );
 
+    // Filter & return
     return (int) apply_filters( 'bbp_update_forum_reply_count', $total_replies, $forum_id );
 }
@@ -2001 +2012 @@
  */
 function bbp_get_forum_statuses( $forum_id = 0 ) {
-    return apply_filters( 'bbp_get_forum_statuses', array(
+
+    // Filter & return
+    return (array) apply_filters( 'bbp_get_forum_statuses', array(
         'open'   => _x( 'Open',    'Open the forum',  'bbpress' ),
         'closed' => _x( 'Closed',  'Close the forum', 'bbpress' )
@@ -2017 +2030 @@
  */
 function bbp_get_forum_types( $forum_id = 0 ) {
-    return apply_filters( 'bbp_get_forum_types', array(
+
+    // Filter & return
+    return (array) apply_filters( 'bbp_get_forum_types', array(
         'forum'    => _x( 'Forum',    'Forum accepts new topics', 'bbpress' ),
         'category' => _x( 'Category', 'Forum is a category',      'bbpress' )
@@ -2033 +2048 @@
  */
 function bbp_get_forum_visibilities( $forum_id = 0) {
-    return apply_filters( 'bbp_get_forum_visibilities', array(
+
+    // Filter & return
+    return (array) apply_filters( 'bbp_get_forum_visibilities', array(
         bbp_get_public_status_id()  => _x( 'Public',  'Make forum public',  'bbpress' ),
         bbp_get_private_status_id() => _x( 'Private', 'Make forum private', 'bbpress' ),
@@ -2060 +2077 @@
         : array();
 
-    return apply_filters( 'bbp_get_hidden_forum_ids', (array) $forum_ids );
+    // Filter & return
+    return (array) apply_filters( 'bbp_get_hidden_forum_ids', $forum_ids );
 }
 
@@ -2081 +2099 @@
         : array();
 
-    return apply_filters( 'bbp_get_private_forum_ids', (array) $forum_ids );
+    // Filter & return
+    return (array) apply_filters( 'bbp_get_private_forum_ids', $forum_ids );
 }
 
@@ -2177 +2196 @@
     }
 
-    // Filter and return the results
+    // Filter & return
     return apply_filters( 'bbp_exclude_forum_ids', $retval, $forum_ids, $type );
 }
@@ -2306 +2325 @@
     $topic_ids = bbp_get_public_child_ids( $forum_id, bbp_get_topic_post_type() );
 
+    // Filter & return
     return (array) apply_filters( 'bbp_forum_query_topic_ids', $topic_ids, $forum_id );
 }
@@ -2325 +2345 @@
     $subforum_ids = bbp_get_all_child_ids( $forum_id, bbp_get_forum_post_type() );
 
+    // Filter & return
     return (array) apply_filters( 'bbp_forum_query_subforum_ids', $subforum_ids, $forum_id );
 }
@@ -2373 +2394 @@
     unset( $query );
 
+    // Filter & return
     return (int) apply_filters( 'bbp_forum_query_last_reply_id', $reply_id, $forum_id );
 }