<!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][10452] trunk/src/bp-groups/bp-groups-template.php: Update bp_has_groups() documentation.</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/10452">10452</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/10452","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>dcavins</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-01-17 14:54:33 +0000 (Sun, 17 Jan 2016)</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'>Update bp_has_groups() documentation.
Update docblock by adding missing parameters,
updating parameter order and correcting
description of default values.
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/6785">#6785</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpgroupsbpgroupstemplatephp">trunk/src/bp-groups/bp-groups-template.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpgroupsbpgroupstemplatephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-groups/bp-groups-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-groups/bp-groups-template.php 2016-01-16 13:31:44 UTC (rev 10451)
+++ trunk/src/bp-groups/bp-groups-template.php 2016-01-17 14:54:33 UTC (rev 10452)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -461,39 +461,53 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array|string $args {
</span><span class="cx" style="display: block; padding: 0 10px"> * Array of parameters. All items are optional.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type string $type Shorthand for certain orderby/
- * order combinations. 'newest',
- * 'active', 'popular', 'alphabetical',
- * 'random'. When present, will override
- * orderby and order params. Default: null.
- * @type string $orderby Property to sort by.
- * 'date_created', 'last_activity', 'total_member_count',
- * 'name', 'random'. Default: 'date_created'.
- * @type string $order Sort order. 'ASC' or 'DESC'.
- * Default: 'DESC'.
- * @type int $per_page Number of items to return per page
- * of results. Default: null (no limit).
- * @type int $page Page offset of results to return.
- * Default: null (no limit).
- * @type int $user_id If provided, results will be limited
- * to groups of which the specified user
- * is a member. Default: null.
- * @type string $search_terms If provided, only groups whose names or descriptions match the search terms
- * will be returned. Default: value of `$_REQUEST['groups_search']` or
- * `$_REQUEST['s']`, if present. Otherwise false.
- * @type array $meta_query An array of meta_query conditions.
- * See {@link WP_Meta_Query::queries} for description.
- * @type array|string $include Array or comma-separated list of
- * group IDs. Results will be limited
- * to groups within the list. Default: false.
- * @type bool $populate_extras Whether to fetch additional information
- * (such as member count) about groups.
- * Default: true.
- * @type array|string $exclude Array or comma-separated list of group IDs.
- * Results will exclude the listed groups.
- * Default: false.
- * @type bool $show_hidden Whether to include hidden groups in
- * results. Default: false.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string $type Shorthand for certain orderby/
+ * order combinations. 'newest',
+ * 'active', 'popular', 'alphabetical',
+ * 'random'. When present, will override
+ * orderby and order params. Default: null.
+ * @type string $order Sort order. 'ASC' or 'DESC'.
+ * Default: 'DESC'.
+ * @type string $orderby Property to sort by.
+ * 'date_created', 'last_activity', 'total_member_count',
+ * 'name', 'random'. Default: 'last_activity'.
+ * @type int $page Page offset of results to return.
+ * Default: 1 (first page of results).
+ * @type int $per_page Number of items to return per page
+ * of results. Default: 20.
+ * @type int $max Does NOT affect query. May change the
+ * reported number of total groups found,
+ * but not the actual number of found
+ * groups. Default: false.
+ * @type bool $show_hidden Whether to include hidden groups in
+ * results. Default: false.
+ * @type string $page_arg Query argument used for pagination.
+ * Default: 'grpage'.
+ * @type int $user_id If provided, results will be limited
+ * to groups of which the specified user
+ * is a member.
+ * Default: value of bp_displayed_user_id().
+ * @type string $slug If provided, only the group with the
+ * matching slug will be returned.
+ * Default: false.
+ * @type string $search_terms If provided, only groups whose names or
+ * descriptions match the search terms will
+ * be returned. Default: value of
+ * `$_REQUEST['groups_search']` or
+ * `$_REQUEST['s']`, if present. Otherwise false.
+ * @type array $meta_query An array of meta_query conditions.
+ * See {@link WP_Meta_Query::queries} for description.
+ * @type array|string $include Array or comma-separated list of
+ * group IDs. Results will be limited
+ * to groups within the list. Default: false.
+ * @type bool $populate_extras Whether to fetch additional information
+ * (such as member count) about groups.
+ * Default: true.
+ * @type array|string $exclude Array or comma-separated list of group IDs.
+ * Results will exclude the listed groups.
+ * Default: false.
+ * @type bool $update_meta_cache Whether to fetch groupmeta for queried groups.
+ * Default: true.
</ins><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> * @return bool True if there are groups to display that match the params
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span></span></pre>
</div>
</div>
</body>
</html>