Changeset 5993 for trunk/bp-core/bp-core-functions.php

Timestamp:

04/17/2012 02:01:16 PM (13 years ago)

Author:

boonebgorges

Message:

Refactors bp_has_activities() stack to support the passing of arguments as associative arrays.

• Maintains backward compatibility by parsing old-style parameters using bp_core_parse_args_array(), converting to new-style array, and throwing _deprecated_argument() error
• Changes calls to BP_Activity_Template::construct() and BP_Activity_Activity::get() to use the new format throughout BuddyPress
• See #3797

File:

• trunk/bp-core/bp-core-functions.php (modified) (1 diff)

trunk/bp-core/bp-core-functions.php

@@ -952 +952 @@
 
     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;
 }