Changeset 10217 for trunk/src/bp-activity/bp-activity-template.php

Timestamp:

10/08/2015 04:59:40 PM (10 years ago)

Author:

boonebgorges

Message:

Introduce fields parameter to bp_has_activities() stack.

fields=ids will fetch only the IDs of matched activities. fields=all
(or any other value of fields, for the moment) will return full activity
objects.

The structure of the array returned from BP_Activity_Activity::get() is the
same regardless of the value of fields: matched items are stored in the
'activities' member of the returned array.

Props r-a-y.
Fixes #6426.

File:

• trunk/src/bp-activity/bp-activity-template.php (modified) (4 diffs)

trunk/src/bp-activity/bp-activity-template.php

@@ -271 +271 @@
             'page_arg'          => 'acpage',
             'max'               => false,
+            'fields'            => 'all',
             'count_total'       => false,
             'sort'              => false,
@@ -508 +509 @@
  *
  * @since 1.0.0
+ * @since 2.4.0 Introduced the `$fields` parameter.
  *
  * @global object $activities_template {@link BP_Activity_Template}
@@ -537 +539 @@
  *     @type string            $page_arg         String used as a query parameter in pagination links. Default: 'acpage'.
  *     @type int|bool          $max              Maximum number of results to return. Default: false (unlimited).
+ *     @type string            $fields           Activity fields to retrieve. 'all' to fetch entire activity objects,
+ *                                               'ids' to get only the activity IDs. Default 'all'.
  *     @type string|bool       $count_total      If true, an additional DB query is run to count the total activity items
  *                                               for the query. Default: false.
@@ -662 +666 @@
         'page_arg'          => 'acpage',     // See https://buddypress.trac.wordpress.org/ticket/3679
         'max'               => false,        // max number to return
+        'fields'            => 'all',
         'count_total'       => false,
         'show_hidden'       => $show_hidden, // Show activity items that are hidden site-wide?