<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[BuddyPress][9255] trunk/src/bp-activity/bp-activity-template.php: Activity: Improve PHPDoc formatting for bp_has_activities().</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://buddypress.trac.wordpress.org/changeset/9255">9255</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://buddypress.trac.wordpress.org/changeset/9255","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>r-a-y</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2014-12-22 20:43:35 +0000 (Mon, 22 Dec 2014)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Activity: Improve PHPDoc formatting for bp_has_activities().</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpactivitybpactivitytemplatephp">trunk/src/bp-activity/bp-activity-template.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpactivitybpactivitytemplatephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-activity/bp-activity-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-activity/bp-activity-template.php 2014-12-22 20:43:13 UTC (rev 9254)
+++ trunk/src/bp-activity/bp-activity-template.php 2014-12-22 20:43:35 UTC (rev 9255)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -433,110 +433,87 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @uses apply_filters() To call the 'bp_has_activities' hook.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $args {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * 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.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * 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.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Arguments can be passed as an associative array, or as a URL query
- * string (eg, 'user_id=4&display_comments=threaded').
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Arguments can be passed as an associative array, or as a URL querystring
+ * (eg, 'user_id=4&display_comments=threaded').
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @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.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @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.
</ins><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> * @return bool Returns true when activities are found, otherwise false.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span></span></pre>
</div>
</div>
</body>
</html>