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

Timestamp:

12/22/2014 08:43:35 PM (10 years ago)

Author:

r-a-y

Message:

Activity: Improve PHPDoc formatting for bp_has_activities().

File:

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

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

@@ -434 +434 @@
  *
  * @param array $args {
- *     Arguments for limiting the contents of the activity loop. Most
- *     arguments are in the same format as {@link BP_Activity_Activity::get()}.
- *     However, because the format of the arguments accepted here differs in
- *     a number of ways, and because bp_has_activities() determines some
- *     default arguments in a dynamic fashion, we list all accepted arguments
- *     here as well.
- *
- *     Arguments can be passed as an associative array, or as a URL query
- *     string (eg, 'user_id=4&display_comments=threaded').
- *
- *     @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: 20.
- *     @type string $page_arg The 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|bool $count_total If true, an additional DB query is run to
- *           count the total activity items for the query. Default: false.
- *     @type string $sort 'ASC' or 'DESC'. Default: 'DESC'.
- *     @type array|bool $exclude Array of activity IDs to exclude. Default: false.
- *     @type array|bool $in Array of IDs to limit query by (IN). 'in' is
- *           intended to be used in conjunction with other filter parameters.
- *           Default: false.
- *     @type array|bool $include Array of exact activity IDs to query.
- *           Providing an 'include' array will override all other filters
- *           passed in the argument array. When viewing a the permalink page
- *           for a single activity item, this value defaults to the ID of that
- *           item. Otherwise the default is false.
- *     @type array $meta_query Limit by activitymeta by passing an array of
- *           meta_query conditions. See {@link WP_Meta_Query::queries} for a
- *           description of the syntax.
- *     @type string $search_terms Limit results by a search term. Default: false.
- *     @type string|bool $scope Use one of BuddyPress's pre-built filters. In
- *           each case, the term 'current user' refers to the displayed user
- *           when looking at a user profile, and otherwise to the logged-in user.
- *             - 'just-me' retrieves items belonging only to the logged-in user;
- *               this is equivalent to passing a 'user_id' argument
- *             - 'friends' retrieves items belonging to the friends of the
- *               current user
- *             - 'groups' retrieves items associated with the groups to which
- *               the current user belongs
- *             - 'favorites' retrieves the current user's favorited activity
- *               items
- *             - 'mentions' retrieves activity items where the current user has
- *               received an @-mention
- *           The default value of 'scope' is set to one of the above if that
- *           value appears in the appropriate place in the URL; eg, 'scope' will
- *           be 'groups' when visiting http://example.com/members/joe/activity/groups/.
- *           Otherwise defaults to false.
- *     @type int|array|bool $user_id The ID(s) of user(s) whose activity should
- *           be fetched. Pass a single ID or an array of IDs. When viewing a
- *           user profile page (but not that user's activity subpages, ie My
- *           Friends, My Groups, etc), 'user_id' defaults to the ID of the
- *           displayed user. Otherwise the default is false.
- *     @type string|array|bool $object Filters by the `component` column in the
- *           database, which is generally the component ID in the case of
- *           BuddyPress components, or the plugin slug in the case of plugins.
- *           For example, 'groups' will limit results to those that are
- *           associated with the BP Groups component. Accepts a single
- *           component string, or an array of multiple components. Defaults to
- *           'groups' when viewing the page of a single group, the My Groups
- *           activity filter, or the Activity > Groups filter of a user profile.
- *           Otherwise defaults to false.
- *     @type string|array|bool $action Filters by the `type` column in the
- *           database, which is a string categorizing the activity item (eg,
- *           'new_blog_post', 'created_group'). Accepts a single type string,
- *           or an array of multiple types. Defaults to false.
- *     @type int|array|bool $primary_id Filters by the `item_id` column in the
- *           database. The meaning of 'primary_id' differs between components/
- *           types; for example, in the case of 'created_group', 'primary_id'
- *           is the ID of the group. Accepts a single ID, or an array of
- *           multiple IDs. When viewing a single group, defaults to the current
- *           group ID. When viewing a user's Groups stream page, defaults to
- *           the IDs of the user's groups. Otherwise defaults to false.
- *     @type int|array|bool $secondary_id Filters by the `secondary_item_id`
- *           column in the database. The meaning of 'secondary_id' differs
- *           between components/types. Accepts a single ID, or an array of
- *           multiple IDs. Defaults to false.
- *     @type int $offset Return only activity items with an ID greater than or
- *           equal to this one. Note that providing an offset will disable
- *           pagination. Default: false.
- *     @type string|bool $display_comments How to handle activity comments.
- *           Possible values:
- *             - 'threaded' - comments appear in a threaded tree, under their
- *               parent items
- *             - 'stream' - the activity stream is presented in a flat manner,
- *               with comments sorted in chronological order alongside other
- *               activity items
- *             - false - don't fetch activity comments at all
- *           Default: 'threaded'.
- *     @type bool $show_hidden Whether to show items marked hide_sitewide.
- *           Defaults to false, except in the following cases:
- *             - User is viewing his own activity stream
- *             - User is viewing the activity stream of a non-public group of
- *               which he is a member
- *     @type bool $show_hidden Normally defaults to false, except when:
- *             - a user is viewing his own activity stream
- *             - a user is viewing the activity stream of a non-public group of
- *               which he is a member
- *     @type string|bool $spam Spam status. 'ham_only', 'spam_only', or false
- *           to show all activity regardless of spam status. Default: 'ham_only'.
- *     @type bool $populate_extras Whether to pre-fetch the activity metadata
- *           for the queried items. Default: true.
+ *     Arguments for limiting the contents of the activity loop. Most arguments
+ *     are in the same format as {@link BP_Activity_Activity::get()}. However,
+ *     because the format of the arguments accepted here differs in a number of
+ *     ways, and because bp_has_activities() determines some default arguments in
+ *     a dynamic fashion, we list all accepted arguments here as well.
+ *
+ *     Arguments can be passed as an associative array, or as a URL querystring
+ *     (eg, 'user_id=4&display_comments=threaded').
+ *
+ *     @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: 20.
+ *     @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|bool       $count_total      If true, an additional DB query is run to count the total activity items
+ *                                               for the query. Default: false.
+ *     @type string            $sort             'ASC' or 'DESC'. Default: 'DESC'.
+ *     @type array|bool        $exclude          Array of activity IDs to exclude. Default: false.
+ *     @type array|bool        $in               Array of IDs to limit query by (IN). 'in' is intended to be used in
+ *                                               conjunction with other filter parameters. Default: false.
+ *     @type array|bool        $include          Array of exact activity IDs to query. Providing an 'include' array will
+ *                                               override all other filters passed in the argument array. When viewing the
+ *                                               permalink page for a single activity item, this value defaults to the ID of
+ *                                               that item. Otherwise the default is false.
+ *     @type array             $meta_query       Limit by activitymeta by passing an array of meta_query conditions. See
+ *                                               {@link WP_Meta_Query::queries} for a description of the syntax.
+ *     @type array             $date_query       Limit by date by passing an array of date_query conditions. See first
+ *                                               parameter of {@link WP_Date_Query::__construct()} for syntax.
+ *     @type string            $search_terms     Limit results by a search term. Default: false.
+ *     @type string            $scope            Use a BuddyPress pre-built filter.
+ *                                                 - 'just-me' retrieves items belonging only to a user; this is equivalent
+ *                                                   to passing a 'user_id' argument
+ *                                                 - 'friends' retrieves items belonging to the friends of a user
+ *                                                 - 'groups' retrieves items belonging to groups to which a user belongs to
+ *                                                 - 'favorites' retrieves a user's favorited activity items
+ *                                                 - 'mentions' retrieves items where a user has received an @-mention
+ *                                               The default value of 'scope' is set to one of the above if that value
+ *                                               appears in the appropriate place in the URL; eg, 'scope' will be 'groups'
+ *                                               when visiting http://example.com/members/joe/activity/groups/. Otherwise
+ *                                               defaults to false.
+ *     @type int|array|bool    $user_id          The ID(s) of user(s) whose activity should be fetched. Pass a single ID or
+ *                                               an array of IDs. When viewing a user profile page (but not that user's
+ *                                               activity subpages, ie My Friends, My Groups, etc), 'user_id' defaults to
+ *                                               the ID of the displayed user. Otherwise the default is false.
+ *     @type string|array|bool $object           Filters by the `component` column in the database, which is generally the
+ *                                               component ID in the case of BuddyPress components, or the plugin slug in
+ *                                               the case of plugins. For example, 'groups' will limit results to those that
+ *                                               are associated with the BP Groups component. Accepts a single component
+ *                                               string, or an array of multiple components. Defaults to 'groups' when
+ *                                               viewing the page of a single group, the My Groups activity filter, or the
+ *                                               Activity > Groups filter of a user profile. Otherwise defaults to false.
+ *     @type string|array|bool $action           Filters by the `type` column in the database, which is a string
+ *                                               categorizing the activity item (eg, 'new_blog_post', 'created_group').
+ *                                               Accepts a comma-delimited string or an array of types. Default: false.
+ *     @type int|array|bool    $primary_id       Filters by the `item_id` column in the database. The meaning of
+ *                                               'primary_id' differs between components/types; for example, in the case of
+ *                                               'created_group', 'primary_id' is the ID of the group. Accepts a single ID,
+ *                                               or an array of multiple IDs. When viewing a single group, defaults to the
+ *                                               current group ID. When viewing a user's Groups stream page, defaults to the
+ *                                               IDs of the user's groups. Otherwise defaults to false.
+ *     @type int|array|bool    $secondary_id     Filters by the `secondary_item_id` column in the database. The meaning of
+ *                                               'secondary_id' differs between components/types. Accepts a single ID, or an
+ *                                               array of multiple IDs. Defaults to false.
+ *     @type int               $offset           Return only activity items with an ID greater than or equal to this one.
+ *                                               Note that providing an offset will disable pagination. Default: false.
+ *     @type string|bool       $display_comments How to handle activity comments. Possible values:
+ *                                                 - 'threaded' - comments appear in a threaded tree, under their parent
+ *                                                   items
+ *                                                 - 'stream' - the activity stream is presented in a flat manner, with
+ *                                                   comments sorted in chronological order alongside other activity items
+ *                                                 - false - don't fetch activity comments at all
+ *                                               Default: 'threaded'.
+ *     @type bool              $show_hidden      Whether to show items marked hide_sitewide. Defaults to false, except in
+ *                                               the following cases:
+ *                                                 - User is viewing his own activity stream
+ *                                                 - User is viewing the activity stream of a non-public group of which he
+ *                                                   is a member
+ *     @type string|bool       $spam             Spam status. 'ham_only', 'spam_only', or false to show all activity
+ *                                               regardless of spam status. Default: 'ham_only'.
+ *     @type bool              $populate_extras  Whether to pre-fetch the activity metadata for the queried items.
+ *                                               Default: true.
  * }
  * @return bool Returns true when activities are found, otherwise false.