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

Timestamp:

12/18/2013 04:53:16 PM (12 years ago)

Author:

johnjamesjacoby

Message:

Introduce bp_parse_args() to bp-core-functions.php, ported from bbPress. See #5306.

File:

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

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

@@ -200 +200 @@
 
     return $new_args;
+}
+
+/**
+ * Merge user defined arguments into defaults array.
+ *
+ * This function is used throughout BuddyPress to allow for either a string or
+ * array to be merged into another array. It is identical to wp_parse_args()
+ * except it allows for arguments to be passively or aggressively filtered using
+ * the optional $filter_key parameter. If no $filter_key is passed, no filters
+ * are applied.
+ *
+ * @since BuddyPress (r7704)
+ *
+ * @param string|array $args Value to merge with $defaults
+ * @param array $defaults Array that serves as the defaults.
+ * @param string $filter_key String to key the filters from
+ * @return array Merged user defined values with defaults.
+ */
+function bp_parse_args( $args, $defaults = array(), $filter_key = '' ) {
+
+    // Setup a temporary array from $args
+    if ( is_object( $args ) ) {
+        $r = get_object_vars( $args );
+    } elseif ( is_array( $args ) ) {
+        $r =& $args;
+    } else {
+        wp_parse_str( $args, $r );
+    }
+
+    // Passively filter the args before the parse
+    if ( !empty( $filter_key ) ) {
+        $r = apply_filters( 'bp_before_' . $filter_key . '_parse_args', $r );
+    }
+
+    // Parse
+    if ( is_array( $defaults ) && !empty( $defaults ) ) {
+        $r = array_merge( $defaults, $r );
+    }
+
+    // Aggressively filter the args after the parse
+    if ( !empty( $filter_key ) ) {
+        $r = apply_filters( 'bp_after_' . $filter_key . '_parse_args', $r );
+    }
+
+    // Return the parsed results
+    return $r;
 }