Changeset 6438 for trunk/src/includes/extend/buddypress/functions.php

Timestamp:

05/27/2017 05:04:31 PM (9 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/extend/buddypress/functions.php (modified) (6 diffs)

trunk/src/includes/extend/buddypress/functions.php

@@ -30 +30 @@
 function bbp_get_component_name() {
 
-        // Use existing ID
-        if ( ! empty( bbpress()->extend->buddypress->id ) ) {
-                $retval = bbpress()->extend->buddypress->id;
-
-        // Use default
-        } else {
-                $retval = 'forums';
-        }
-
+        // Use existing ID or default
+        $retval = ! empty( bbpress()->extend->buddypress->id )
+                ? bbpress()->extend->buddypress->id
+                : 'forums';
+
+        // Filter & return
         return apply_filters( 'bbp_get_component_name', $retval );
 }
@@ -65 +62 @@
         if ( ! empty( $user_id ) && is_numeric( $user_id ) ) {
                 $bbp_user_id = $user_id;
-        }
 
         // Currently viewing or editing a user
-        elseif ( ( true === $displayed_user_fallback ) && ! empty( $did ) ) {
+        } elseif ( ( true === $displayed_user_fallback ) && ! empty( $did ) ) {
                 $bbp_user_id = $did;
-        }
 
         // Maybe fallback on the current_user ID
-        elseif ( ( true === $current_user_fallback ) && ! empty( $lid ) ) {
+        } elseif ( ( true === $current_user_fallback ) && ! empty( $lid ) ) {
                 $bbp_user_id = $lid;
         }
@@ -81 +76 @@
 
 /**
- * Filter the bbPress is_single_user function with BuddyPress eqivalent
+ * Filter the bbPress is_single_user function with BuddyPress equivalent
  *
  * @since 2.1.0 bbPress (r3552)
@@ -97 +92 @@
 
 /**
- * Filter the bbPress is_user_home function with BuddyPress eqivalent
+ * Filter the bbPress is_user_home function with BuddyPress equivalent
  *
  * @since 2.1.0 bbPress (r3552)
@@ -578 +573 @@
         $retval    = (bool) ! empty( $group_ids );
 
+        // Filter & return
         return (bool) apply_filters( 'bbp_is_forum_group_forum', $retval, $forum_id, $group_ids );
 }
@@ -748 +744 @@
  */
 function bbp_get_activity_actions() {
-        return apply_filters( 'bbp_get_activity_actions', array(
+
+        // Filter & return
+        return (array) apply_filters( 'bbp_get_activity_actions', array(
                 'topic' => __( '%1$s started the topic %2$s in the forum %3$s',    'bbpress' ),
                 'reply' => __( '%1$s replied to the topic %2$s in the forum %3$s', 'bbpress' )