Changeset 6438 for trunk/src/includes/replies/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/replies/functions.php (modified) (11 diffs)

trunk/src/includes/replies/functions.php

@@ -77 +77 @@
     do_action( 'bbp_insert_reply', (int) $reply_id, (int) $reply_meta['topic_id'], (int) $reply_meta['forum_id'] );
 
-    // Return new reply ID
+    // Return reply_id
     return $reply_id;
 }
@@ -1089 +1089 @@
     $forum_id = bbp_update_forum_id( $reply_id, $forum_id );
 
+    // Filter & return
     return (int) apply_filters( 'bbp_update_reply_forum_id', $forum_id, $reply_id );
 }
@@ -1138 +1139 @@
     $topic_id = bbp_update_topic_id( $reply_id, $topic_id );
 
+    // Filter & return
     return (int) apply_filters( 'bbp_update_reply_topic_id', $topic_id, $reply_id );
 }
@@ -1173 +1175 @@
     }
 
+    // Filter & return
     return (int) apply_filters( 'bbp_update_reply_to', $reply_to, $reply_id );
 }
@@ -1222 +1225 @@
     }
 
+    // Filter & return
     return (array) apply_filters( 'bbp_get_reply_ancestors', $ancestors, $reply_id );
 }
@@ -1264 +1268 @@
     update_post_meta( $r['reply_id'], '_bbp_revision_log', $revision_log );
 
+    // Filter & return
     return apply_filters( 'bbp_update_reply_revision_log', $revision_log, $r['reply_id'] );
 }
@@ -1765 +1770 @@
  */
 function bbp_get_reply_statuses( $reply_id = 0 ) {
-    return apply_filters( 'bbp_get_reply_statuses', array(
+
+    // Filter & return
+    return (array) apply_filters( 'bbp_get_reply_statuses', array(
         bbp_get_public_status_id()  => _x( 'Publish', 'Publish the reply',     'bbpress' ),
         bbp_get_spam_status_id()    => _x( 'Spam',    'Spam the reply',        'bbpress' ),
@@ -1783 +1790 @@
  */
 function bbp_get_reply_toggles( $reply_id = 0 ) {
-    return apply_filters( 'bbp_get_toggle_reply_actions', array(
+
+    // Filter & return
+    return (array) apply_filters( 'bbp_get_toggle_reply_actions', array(
         'bbp_toggle_reply_spam',
         'bbp_toggle_reply_trash',
@@ -2115 +2124 @@
     }
 
-    // Filter and return
+    // Filter & return
     return (int) apply_filters( 'bbp_get_replies_per_page', $retval, $default );
 }
@@ -2139 +2148 @@
     }
 
-    // Filter and return
+    // Filter & return
     return (int) apply_filters( 'bbp_get_replies_per_rss_page', $retval, $default );
 }
@@ -2513 +2522 @@
     }
 
+    // Filter & return
     return (bool) apply_filters( 'bbp_thread_replies', $retval, $depth, $allow );
 }