Ticket #6063: 6063-assoc-array-args.diff

src/bp-messages/bp-messages-classes.php

@@ -319 +319 @@
          *
          * @since BuddyPress (1.0.0)
          *
-         * @param int    $user_id The user ID.
-         * @param string $box  The type of mailbox to get. Either 'inbox' or 'sentbox'.
-         *                     Defaults to 'inbox'.
-         * @param string $type The type of messages to get. Either 'all' or 'unread'
-         *                     or 'read'. Defaults to 'all'.
-         * @param int    $limit The number of messages to get. Defaults to null.
-         * @param int    $page  The page number to get. Defaults to null.
-         * @param string $search_terms The search term to use. Defaults to ''.
+         * @param array $args {
+         *     Array of arguments.
+         *     @type int    $user_id      The user ID.
+         *     @type string $box          The type of mailbox to get. Either 'inbox' or 'sentbox'.
+         *                                Defaults to 'inbox'.
+         *     @type string $type         The type of messages to get. Either 'all' or 'unread'
+         *                                or 'read'. Defaults to 'all'.
+         *     @type int    $limit        The number of messages to get. Defaults to null.
+         *     @type int    $page         The page number to get. Defaults to null.
+         *     @type string $search_terms The search term to use. Defaults to ''.
+         *     @type array  $meta_query   Meta query arguments. See WP_Meta_Query for more details.
+         * }
          * @return array|bool Array on success. Boolean false on failure.
          */
-        public static function get_current_threads_for_user( $user_id, $box = 'inbox', $type = 'all', $limit = null, $page = null, $search_terms = '' ) {
+        public static function get_current_threads_for_user( $args = array() ) {
                 global $wpdb, $bp;
 
+                // Backward compatibility with old method of passing arguments
+                if ( ! is_array( $args ) || func_num_args() > 1 ) {
+                        _deprecated_argument( __METHOD__, '2.2.0', sprintf( __( 'Arguments passed to %1$s should be in an associative array. See the inline documentation at %2$s for more details.', 'buddypress' ), __METHOD__, __FILE__ ) );
+
+                        $old_args_keys = array(
+                                0 => 'user_id',
+                                1 => 'box',
+                                2 => 'type',
+                                3 => 'limit',
+                                4 => 'page',
+                                5 => 'search_terms',
+                        );
+
+                        $func_args = func_get_args();
+                        $args      = bp_core_parse_args_array( $old_args_keys, $func_args );
+                }
+
+                $defaults = array(
+                        'user_id'      => false,
+                        'box'          => 'inbox',
+                        'type'         => 'all',
+                        'limit'        => null,
+                        'page'         => null,
+                        'search_terms' => ''
+                );
+                $r = wp_parse_args( $args, $defaults );
+
                 $user_id_sql = $pag_sql = $type_sql = $search_sql = '';
 
-                if ( $limit && $page ) {
-                        $pag_sql = $wpdb->prepare( " LIMIT %d, %d", intval( ( $page - 1 ) * $limit), intval( $limit ) );
+                if ( $r['limit'] && $r['page'] ) {
+                        $pag_sql = $wpdb->prepare( " LIMIT %d, %d", intval( ( $r['page'] - 1 ) * $r['limit'] ), intval( $r['limit'] ) );
                 }
 
-                if ( $type == 'unread' ) {
+                if ( $r['type'] == 'unread' ) {
                         $type_sql = " AND r.unread_count != 0 ";
-                } elseif ( $type == 'read' ) {
+                } elseif ( $r['type'] == 'read' ) {
                         $type_sql = " AND r.unread_count = 0 ";
                 }
 
-                if ( ! empty( $search_terms ) ) {
-                        $search_terms_like = '%' . bp_esc_like( $search_terms ) . '%';
+                if ( ! empty( $r['search_terms'] ) ) {
+                        $search_terms_like = '%' . bp_esc_like( $r['search_terms'] ) . '%';
                         $search_sql        = $wpdb->prepare( "AND ( subject LIKE %s OR message LIKE %s )", $search_terms_like, $search_terms_like );
                 }
 
-                if ( 'sentbox' == $box ) {
-                        $user_id_sql = $wpdb->prepare( 'm.sender_id = %d', $user_id );
+                if ( 'sentbox' == $r['box'] ) {
+                        $user_id_sql = $wpdb->prepare( 'm.sender_id = %d', $r['user_id'] );
                         $thread_ids  = $wpdb->get_results( "SELECT m.thread_id, MAX(m.date_sent) AS date_sent FROM {$bp->messages->table_name_recipients} r, {$bp->messages->table_name_messages} m WHERE m.thread_id = r.thread_id AND m.sender_id = r.user_id AND {$user_id_sql} AND r.is_deleted = 0 {$search_sql} GROUP BY m.thread_id ORDER BY date_sent DESC {$pag_sql}" );
                         $total_threads = $wpdb->get_var( "SELECT COUNT( DISTINCT m.thread_id ) FROM {$bp->messages->table_name_recipients} r, {$bp->messages->table_name_messages} m WHERE m.thread_id = r.thread_id AND m.sender_id = r.user_id AND {$user_id_sql} AND r.is_deleted = 0 {$search_sql} " );
                 } else {
-                        $user_id_sql = $wpdb->prepare( 'r.user_id = %d', $user_id );
+                        $user_id_sql = $wpdb->prepare( 'r.user_id = %d', $r['user_id'] );
                         $thread_ids = $wpdb->get_results( "SELECT m.thread_id, MAX(m.date_sent) AS date_sent FROM {$bp->messages->table_name_recipients} r, {$bp->messages->table_name_messages} m WHERE m.thread_id = r.thread_id AND r.is_deleted = 0 AND {$user_id_sql} AND r.sender_only = 0 {$type_sql} {$search_sql} GROUP BY m.thread_id ORDER BY date_sent DESC {$pag_sql}" );
                         $total_threads = $wpdb->get_var( "SELECT COUNT( DISTINCT m.thread_id ) FROM {$bp->messages->table_name_recipients} r, {$bp->messages->table_name_messages} m WHERE m.thread_id = r.thread_id AND r.is_deleted = 0 AND {$user_id_sql} AND r.sender_only = 0 {$type_sql} {$search_sql}" );
                 }