Changeset 7879 for trunk/bp-activity/bp-activity-functions.php

Timestamp:

02/14/2014 01:59:32 PM (11 years ago)

Author:

boonebgorges

Message:

Add support for $single param in _get_meta() functions

Unlike get_metadata(), we are defaulting to $single = true, for backward
compatibility.

See #5400

File:

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

trunk/bp-activity/bp-activity-functions.php

@@ -592 +592 @@
  * @uses apply_filters() To call the 'bp_activity_get_meta' hook.
  *
- * @param int $activity_id ID of the activity item whose metadata is being requseted.
+ * @param int $activity_id ID of the activity item whose metadata is being requested.
  * @param string $meta_key Optional. If present, only the metadata matching
- *                         that meta key will be returned. Otherwise, all
- *                         metadata for the activity item will be fetched.
+ *        that meta key will be returned. Otherwise, all metadata for the
+ *        activity item will be fetched.
+ * @param bool $single Optional. If true, return only the first value of the
+ *    specified meta_key. This parameter has no effect if meta_key is not
+ *    specified. Default: true.
  * @return mixed The meta value(s) being requested.
  */