Ticket #3797: 3797.02.patch

bp-activity/bp-activity-classes.php

@@ -100 +100 @@
         }
 
         // Static Functions
-        function get( $max = false, $page = 1, $per_page = 25, $sort = 'DESC', $search_terms = false, $filter = false, $display_comments = false, $show_hidden = false, $exclude = false, $in = false, $spam = 'ham_only' ) {
+        
+        /**
+         * Get activity items, as specified by parameters
+         *
+         * @param array $args See $defaults for explanation of arguments
+         * @return array
+         */
+        function get( $args = array() ) {
                 global $wpdb, $bp;
 
+                // Backward compatibility with old method of passing arguments
+                if ( !is_array( $args ) || func_num_args() > 1 ) {
+                        _deprecated_argument( __METHOD__, '1.6', sprintf( __( 'Arguments passed to %s should be in an associative array. See the inline documentation for more details.', 'buddypress' ), __METHOD__ ) );
+                
+                        $old_args_keys = array(
+                                0 => 'max',
+                                1 => 'page',
+                                2 => 'per_page',
+                                3 => 'sort',
+                                4 => 'search_terms',
+                                5 => 'filter',
+                                6 => 'display_comments',
+                                7 => 'show_hidden',
+                                8 => 'exclude',
+                                9 => 'in',
+                                10 => 'spam'
+                        );
+                        
+                        $args = bp_core_parse_args_array( $old_args_keys, func_get_args() );
+                }
+                
+                $defaults = array(
+                        'page'             => 1,
+                        'per_page'         => 25,
+                        'max'              => false,
+                        'sort'             => 'DESC',
+                        'exclude'          => false,
+                        'in'               => false,
+                        'filter'           => false,
+                        'search_terms'     => false,
+                        'display_comments' => false,
+                        'show_hidden'      => false,
+                        'spam'             => 'ham_only',
+                );
+                $r = wp_parse_args( $args, $defaults );
+                extract( $r );
+
                 // Select conditions
                 $select_sql = "SELECT a.*, u.user_email, u.user_nicename, u.user_login, u.display_name";
 
@@ -250 +294 @@
          * @since 1.2
          */
         function get_specific( $activity_ids, $max = false, $page = 1, $per_page = 25, $sort = 'DESC', $display_comments = false ) {
-                _deprecated_function( __FUNCTION__, '1.5', 'Use BP_Activity_Activity::get( ..., $in ) instead.' );
+                _deprecated_function( __FUNCTION__, '1.5', 'Use BP_Activity_Activity::get() with the "in" parameter instead.' );
                 return BP_Activity_Activity::get( $max, $page, $per_page, $sort, false, false, $display_comments, false, false, $activity_ids );
         }
 

bp-activity/bp-activity-functions.php

@@ -820 +820 @@
         // Attempt to return a cached copy of the first page of sitewide activity.
         if ( 1 == (int) $page && empty( $max ) && empty( $search_terms ) && empty( $filter ) && empty( $exclude ) && empty( $in ) && 'DESC' == $sort && empty( $exclude ) && 'ham_only' == $spam ) {
                 if ( !$activity = wp_cache_get( 'bp_activity_sitewide_front', 'bp' ) ) {
-                        $activity = BP_Activity_Activity::get( $max, $page, $per_page, $sort, $search_terms, $filter, $display_comments, $show_hidden, false, false, $spam );
+                        $args = array(
+                                'page'             => $page,
+                                'per_page'         => $per_page,
+                                'max'              => $max,
+                                'sort'             => $sort,
+                                'search_terms'     => $search_terms,
+                                'filter'           => $filter,
+                                'display_comments' => $display_comments,
+                                'show_hidden'      => $show_hidden,
+                                'spam'             => $spam
+                        );
+                        $activity = BP_Activity_Activity::get( $args );
                         wp_cache_set( 'bp_activity_sitewide_front', $activity, 'bp' );
                 }
 
         } else {
-                $activity = BP_Activity_Activity::get( $max, $page, $per_page, $sort, $search_terms, $filter, $display_comments, $show_hidden, $exclude, $in, $spam );
+                $args = array(
+                        'page'             => $page,
+                        'per_page'         => $per_page,
+                        'max'              => $max,
+                        'sort'             => $sort,
+                        'search_terms'     => $search_terms,
+                        'filter'           => $filter,
+                        'display_comments' => $display_comments,
+                        'show_hidden'      => $show_hidden,
+                        'exclude'          => $exclude,
+                        'in'               => $in,
+                        'spam'             => $spam
+                );
+                $activity = BP_Activity_Activity::get( $args );
         }
 
         return apply_filters_ref_array( 'bp_activity_get', array( &$activity, &$r ) );
@@ -858 +882 @@
         $r = wp_parse_args( $args, $defaults );
         extract( $r, EXTR_SKIP );
 
+        $get_args = array(
+                'page'             => $page,
+                'per_page'         => $per_page,
+                'max'              => $max,
+                'sort'             => $sort,
+                'display_comments' => $display_comments,
+                'show_hidden'      => $show_hidden,
+                'in'               => $activity_ids,
+                'spam'             => $spam
+        );
         return apply_filters( 'bp_activity_get_specific', BP_Activity_Activity::get( $max, $page, $per_page, $sort, false, false, $display_comments, $show_hidden, false, $activity_ids, $spam ) );
 }
 

bp-activity/bp-activity-template.php

@@ -104 +104 @@
 
         var $full_name;
 
-        function __construct( $page, $per_page, $max, $include, $sort, $filter, $search_terms, $display_comments, $show_hidden, $exclude = false, $in = false, $spam = 'ham_only', $page_arg = 'acpage' ) {
+        /**
+         * Constructor method
+         *
+         * See definition of $defaults below, as well as $defaults in bp_has_activities(), for 
+         * description of $args array
+         *
+         * @param array $args
+         */
+        function __construct( $args ) {
                 global $bp;
 
+                // Backward compatibility with old method of passing arguments
+                if ( !is_array( $args ) || func_num_args() > 1 ) {
+                        _deprecated_argument( __METHOD__, '1.6', sprintf( __( 'Arguments passed to %s should be in an associative array. See the inline documentation for more details.', 'buddypress' ), __METHOD__ ) );
+                
+                        $old_args_keys = array(
+                                0 => 'page',
+                                1 => 'per_page',
+                                2 => 'max',
+                                3 => 'include',
+                                4 => 'sort',
+                                5 => 'filter',
+                                6 => 'search_terms',
+                                7 => 'display_comments',
+                                8 => 'show_hidden',
+                                9 => 'exclude',
+                                10 => 'in',
+                                11 => 'spam',
+                                12 => 'page_arg'
+                        );
+                        
+                        $args = bp_core_parse_args_array( $old_args_keys, func_get_args() );
+                }
+                
+                $defaults = array(
+                        'page'             => 1,
+                        'per_page'         => 20,
+                        'page_arg'         => 'acpage',
+                        'max'              => false,
+                        'sort'             => false,
+                        'include'          => false,
+                        'exclude'          => false,
+                        'in'               => false,
+                        'filter'           => false,
+                        'search_terms'     => false,
+                        'display_comments' => 'threaded',
+                        'show_hidden'      => false,
+                        'spam'             => 'ham_only',
+                );
+                $r = wp_parse_args( $args, $defaults );
+                extract( $r );
+                
                 $this->pag_page = isset( $_REQUEST[$page_arg] ) ? intval( $_REQUEST[$page_arg] ) : $page;
                 $this->pag_num  = isset( $_REQUEST['num'] ) ? intval( $_REQUEST['num'] ) : $per_page;
 
@@ -389 +438 @@
         if ( !empty( $include ) && ( 'ham_only' == $spam ) )
                 $spam = 'all';
 
-        $activities_template = new BP_Activity_Template( $page, $per_page, $max, $include, $sort, $filter, $search_terms, $display_comments, $show_hidden, $exclude, $in, $spam, $page_arg );
+        $template_args = array(
+                'page'             => $page,
+                'per_page'         => $per_page,
+                'page_arg'         => $page_arg,
+                'max'              => $max,
+                'sort'             => $sort,
+                'include'          => $include,
+                'exclude'          => $exclude,
+                'in'               => $in,
+                'filter'           => $filter,
+                'search_terms'     => $search_terms,
+                'display_comments' => $display_comments,
+                'show_hidden'      => $show_hidden,
+                'spam'             => $spam
+        );
+
+        $activities_template = new BP_Activity_Template( $template_args );
 
-        return apply_filters( 'bp_has_activities', $activities_template->has_activities(), $activities_template );
+        return apply_filters( 'bp_has_activities', $activities_template->has_activities(), $activities_template, $template_args );
 }
 
 /**

bp-core/bp-core-functions.php

@@ -953 +953 @@
         return apply_filters( 'bp_use_wp_admin_bar', $use_admin_bar );
 }
 
+/**
+ * A utility for parsing individual function arguments into an array.
+ *
+ * The purpose of this function is to help with backward compatibility in cases where 
+ *
+ *   function foo( $bar = 1, $baz = false, $barry = array(), $blip = false ) { // ...
+ *
+ * is deprecated in favor of
+ *
+ *   function foo( $args = array() ) {
+ *       $defaults = array(
+ *           'bar'  => 1,
+ *           'arg2' => false,
+ *           'arg3' => array(),
+ *           'arg4' => false,
+ *       );
+ *       $r = wp_parse_args( $args, $defaults ); // ...
+ *
+ * The first argument, $old_args_keys, is an array that matches the parameter positions (keys) to
+ * the new $args keys (values):
+ *
+ *   $old_args_keys = array(
+ *       0 => 'bar', // because $bar was the 0th parameter for foo()
+ *       1 => 'baz', // because $baz was the 1st parameter for foo()
+ *       2 => 'barry', // etc
+ *       3 => 'blip'
+ *   );
+ *
+ * For the second argument, $func_args, you should just pass func_get_args().
+ *
+ * @since BuddyPress (1.6)
+ * @param array $old_args_keys
+ * @param array $func_args
+ * @return array $new_args
+ */
+function bp_core_parse_args_array( $old_args_keys, $func_args ) {
+        $new_args = array();
+
+        foreach( $old_args_keys as $arg_num => $arg_key ) {
+                if ( isset( $func_args[$arg_num] ) ) {
+                        $new_args[$arg_key] = $func_args[$arg_num];
+                }
+        }
+
+        return $new_args;
+}
+
 /** Embeds ********************************************************************/
 
 /**