Changeset 9254

Timestamp:

12/22/2014 08:43:13 PM (11 years ago)

Author:

r-a-y

Message:

Activity: Improve PHPDoc formatting for BP_Activity_Activity::get().

File:

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

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

@@ -260 +260 @@
      * @param array $args {
      *     An array of arguments. All items are optional.
-     *     @type int $page Which page of results to fetch. Using page=1
-     *                     without per_page will result in no pagination.
-     *                     Default: 1.
-     *     @type int|bool $per_page Number of results per page. Default: 25.
-     *     @type int|bool $max Maximum number of results to return.
-     *                         Default: false (unlimited).
-     *     @type string $sort ASC or DESC. Default: 'DESC'.
-     *     @type array $exclude Array of activity IDs to exclude.
-     *                          Default: false.
-     *     @type array $in Array of ids to limit query by (IN).
-     *                     Default: false.
-     *     @type array $meta_query An array of meta_query conditions.
-     *                             See WP_Meta_Query::queries for description.
-     *     @type array $date_query An array of date_query conditions.
-     *                             See first parameter of WP_Date_Query::__construct()
-     *                             for description.
-     *     @type array $filter See BP_Activity_Activity::get_filter_sql().
-     *     @type string $search_terms Limit results by a search term.
-     *                                Default: false.
-     *     @type bool $display_comments Whether to include activity comments.
-     *                                  Default: false.
-     *     @type bool $show_hidden Whether to show items marked hide_sitewide.
-     *                             Default: false.
-     *     @type string $spam Spam status. Default: 'ham_only'.
-     *     @type bool $update_meta_cache Whether to pre-fetch metadata for
-     *           queried activity items. Default: true.
-     *     @type string|bool $count_total If true, an additional DB query
-     *           is run to count the total activity items for the query.
-     *           Default: false.
+     *
+     *     @type int         $page              Which page of results to fetch. Using page=1 without per_page will result
+     *                                          in no pagination. Default: 1.
+     *     @type int|bool    $per_page          Number of results per page. Default: 25.
+     *     @type int|bool    $max               Maximum number of results to return. Default: false (unlimited).
+     *     @type string      $sort              ASC or DESC. Default: 'DESC'.
+     *     @type array       $exclude           Array of activity IDs to exclude. Default: false.
+     *     @type array       $in                Array of ids to limit query by (IN). Default: false.
+     *     @type array       $meta_query        Array of meta_query conditions. See WP_Meta_Query::queries.
+     *     @type array       $date_query        Array of date_query conditions. See first parameter of
+     *                                          WP_Date_Query::__construct().
+     *     @type array       $filter            See BP_Activity_Activity::get_filter_sql().
+     *     @type string      $search_terms      Limit results by a search term. Default: false.
+     *     @type bool        $display_comments  Whether to include activity comments. Default: false.
+     *     @type bool        $show_hidden       Whether to show items marked hide_sitewide. Default: false.
+     *     @type string      $spam              Spam status. Default: 'ham_only'.
+     *     @type bool        $update_meta_cache Whether to pre-fetch metadata for queried activity items. Default: true.
+     *     @type string|bool $count_total       If true, an additional DB query is run to count the total activity items
+     *                                          for the query. Default: false.
      * }
      * @return array The array returned has two keys: