Changeset 7924

Timestamp:

02/18/2014 05:03:52 PM (12 years ago)

Author:

johnjamesjacoby

Message:

Clean up bp_has_message_threads():

• Move default box ahead of argument parsing so it can be overridden VS being forced.
• Remove unused $bp global.
• Use bp_parse_args() so arguments can be filtered before they are queried.
• Pass $r into bp_has_message_threads filter.
• Add inline documentation and phpdoc block.

File:

• trunk/bp-messages/bp-messages-template.php (modified) (2 diffs)

trunk/bp-messages/bp-messages-template.php

@@ -166 +166 @@
 }
 
+/**
+ * Retrieve private message threads for display in inbox/sentbox/notices
+ *
+ * Similar to WordPress's have_posts() function, this function is responsible
+ * for querying the database and retrieving private messages for display inside
+ * the theme via individual template parts for a member's inbox/sentbox/notices.
+ *
+ * @since BuddyPress (1.0.0)
+ *
+ * @global BP_Messages_Box_Template $messages_template
+ * @param array $args
+ * @return object
+ */
 function bp_has_message_threads( $args = '' ) {
-    global $bp, $messages_template;
-
-    $defaults = array(
+    global $messages_template;
+
+    // The default box the user is looking at
+    if ( bp_is_current_action( 'sentbox' ) ) {
+        $default_box = 'sentbox';
+    } elseif ( bp_is_current_action( 'notices' ) ) {
+        $default_box = 'notices';
+    } else {
+        $default_box = 'inbox';
+    }
+
+    // Parse the arguments
+    $r = bp_parse_args( $args, array(
         'user_id'      => bp_loggedin_user_id(),
-        'box'          => 'inbox',
+        'box'          => $default_box,
         'per_page'     => 10,
         'max'          => false,
@@ -177 +200 @@
         'search_terms' => isset( $_REQUEST['s'] ) ? stripslashes( $_REQUEST['s'] ) : '',
         'page_arg'     => 'mpage', // See https://buddypress.trac.wordpress.org/ticket/3679
-    );
-
-    $r = wp_parse_args( $args, $defaults );
-    extract( $r, EXTR_SKIP );
-
+    ), 'has_message_threads' );
+
+    // If trying to access notices without capabilities, redirect to root domain
     if ( bp_is_current_action( 'notices' ) && !bp_current_user_can( 'bp_moderate' ) ) {
         bp_core_redirect( bp_displayed_user_domain() );
-    } else {
-        if ( bp_is_current_action( 'sentbox' ) ) {
-            $box = 'sentbox';
-        }
-
-        if ( bp_is_current_action( 'notices' ) ) {
-            $box = 'notices';
-        }
-
-        $messages_template = new BP_Messages_Box_Template( $user_id, $box, $per_page, $max, $type, $search_terms, $page_arg );
-    }
-
-    return apply_filters( 'bp_has_message_threads', $messages_template->has_threads(), $messages_template );
+    }
+
+    // Load the messages loop global up with messages
+    $messages_template = new BP_Messages_Box_Template(
+        $r['user_id'],
+        $r['box'],
+        $r['per_page'],
+        $r['max'],
+        $r['type'],
+        $r['search_terms'],
+        $r['page_arg']
+    );
+
+    return apply_filters( 'bp_has_message_threads', $messages_template->has_threads(), $messages_template, $r );
 }