<!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][8503] trunk/src/bp-groups/bp-groups-template.php: Improvements to `bp_has_groups()`:</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">
<dt>Revision</dt> <dd><a href="http://buddypress.trac.wordpress.org/changeset/8503">8503</a></dd>
<dt>Author</dt> <dd>johnjamesjacoby</dd>
<dt>Date</dt> <dd>2014-06-11 22:30:00 +0000 (Wed, 11 Jun 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Improvements to `bp_has_groups()`:
* Add phpdoc from `BP_Groups_Template::get()`
* Add inline doc better explaining what default values are.
* Move `$defaults` into `bp_parse_args()` call to remove one-time-use variable.
* Fix seemingly unused `$order` parameter noted in <a href="http://buddypress.trac.wordpress.org/changeset/7087">r7087</a> to check action variable in the `my-groups` context.
* Remove `$bp` global touch.</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>Modified: trunk/src/bp-groups/bp-groups-template.php (8502 => 8503)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/bp-groups/bp-groups-template.php 2014-06-10 21:16:20 UTC (rev 8502)
+++ trunk/src/bp-groups/bp-groups-template.php 2014-06-11 22:30:00 UTC (rev 8503)
</span><span class="lines">@@ -292,79 +292,103 @@
</span><span class="cx"> /**
</span><span class="cx"> * Start the Groups Template Loop
</span><span class="cx"> *
</span><del>- * See the $defaults definition below for a description of parameters.
</del><ins>+ * @since BuddyPress (1.0.0)
</ins><span class="cx"> *
</span><del>- * Note that the 'type' parameter overrides 'order' and 'orderby'. See
- * BP_Groups_Group::get() for more details.
</del><ins>+ * @param array $args {
+ * Array of parameters. All items are optional.
+ * @type string $type Optional. Shorthand for certain orderby/
+ * order combinations. 'newest', 'active', 'popular',
+ * 'alphabetical', 'random'. When present, will override
+ * orderby and order params. Default: null.
+ * @type string $orderby Optional. Property to sort by.
+ * 'date_created', 'last_activity', 'total_member_count',
+ * 'name', 'random'. Default: 'date_created'.
+ * @type string $order Optional. Sort order. 'ASC' or 'DESC'.
+ * Default: 'DESC'.
+ * @type int $per_page Optional. Number of items to return per page
+ * of results. Default: null (no limit).
+ * @type int $page Optional. Page offset of results to return.
+ * Default: null (no limit).
+ * @type int $user_id Optional. If provided, results will be limited
+ * to groups of which the specified user is a member. Default:
+ * null.
+ * @type string $search_terms Optional. If provided, only groups
+ * whose names or descriptions match the search terms will be
+ * returned. Default: false.
+ * @type array $meta_query Optional. An array of meta_query
+ * conditions. See {@link WP_Meta_Query::queries} for
+ * description.
+ * @type array|string Optional. 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 Optional. 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.
+ * }
</ins><span class="cx"> *
</span><del>- * @param array $args
</del><span class="cx"> * @return bool True if there are groups to display that match the params
</span><span class="cx"> */
</span><span class="cx"> function bp_has_groups( $args = '' ) {
</span><del>- global $groups_template, $bp;
</del><ins>+ global $groups_template;
</ins><span class="cx">
</span><span class="cx"> /***
</span><del>- * Set the defaults based on the current page. Any of these will be overridden
- * if arguments are directly passed into the loop. Custom plugins should always
- * pass their parameters directly to the loop.
</del><ins>+ * Defaults based on the current page & overridden by parsed $args
</ins><span class="cx"> */
</span><del>- $slug = false;
- $type = '';
- $user_id = 0;
- $order = '';
</del><ins>+ $slug = false;
+ $type = '';
+ $search_terms = false;
</ins><span class="cx">
</span><del>- // User filtering
- if ( bp_displayed_user_id() )
- $user_id = bp_displayed_user_id();
-
- // Type
- // @todo What is $order? At some point it was removed incompletely?
</del><ins>+ // When looking your own groups, check for two action variables
</ins><span class="cx"> if ( bp_is_current_action( 'my-groups' ) ) {
</span><del>- if ( 'most-popular' == $order ) {
</del><ins>+ if ( bp_is_action_variable( 'most-popular', 0 ) ) {
</ins><span class="cx"> $type = 'popular';
</span><del>- } elseif ( 'alphabetically' == $order ) {
</del><ins>+ } elseif ( bp_is_action_variable( 'alphabetically', 0 ) ) {
</ins><span class="cx"> $type = 'alphabetical';
</span><span class="cx"> }
</span><ins>+
+ // When looking at invites, set type to invites
</ins><span class="cx"> } elseif ( bp_is_current_action( 'invites' ) ) {
</span><span class="cx"> $type = 'invites';
</span><del>- } elseif ( isset( $bp->groups->current_group->slug ) && $bp->groups->current_group->slug ) {
</del><ins>+
+ // When looking at a single group, set the type and slug
+ } elseif ( bp_get_current_group_slug() ) {
</ins><span class="cx"> $type = 'single-group';
</span><del>- $slug = $bp->groups->current_group->slug;
</del><ins>+ $slug = bp_get_current_group_slug();
</ins><span class="cx"> }
</span><span class="cx">
</span><del>- // Default search string
</del><ins>+ // Default search string (too soon to escape here)
</ins><span class="cx"> if ( ! empty( $_REQUEST['group-filter-box'] ) ) {
</span><span class="cx"> $search_terms = $_REQUEST['group-filter-box'];
</span><del>- } elseif ( isset( $_REQUEST['s'] ) && !empty( $_REQUEST['s'] ) ) {
</del><ins>+ } elseif ( !empty( $_REQUEST['s'] ) ) {
</ins><span class="cx"> $search_terms = $_REQUEST['s'];
</span><del>- } else {
- $search_terms = false;
</del><span class="cx"> }
</span><span class="cx">
</span><del>- $defaults = array(
- 'type' => $type, // 'type' is an override for 'order' and 'orderby'. See docblock.
</del><ins>+ // Parse defaults and requested arguments
+ $r = bp_parse_args( $args, array(
+ 'type' => $type,
</ins><span class="cx"> 'order' => 'DESC',
</span><span class="cx"> 'orderby' => 'last_activity',
</span><span class="cx"> 'page' => 1,
</span><span class="cx"> 'per_page' => 20,
</span><span class="cx"> 'max' => false,
</span><span class="cx"> 'show_hidden' => false,
</span><del>-
- 'page_arg' => 'grpage', // See https://buddypress.trac.wordpress.org/ticket/3679
-
- 'user_id' => $user_id, // Pass a user ID to limit to groups this user has joined
- 'slug' => $slug, // Pass a group slug to only return that group
- 'search_terms' => $search_terms, // Pass search terms to return only matching groups
- 'meta_query' => false, // Filter by groupmeta. See WP_Meta_Query for format
- 'include' => false, // Pass comma separated list or array of group ID's to return only these groups
- 'exclude' => false, // Pass comma separated list or array of group ID's to exclude these groups
-
- 'populate_extras' => true, // Get extra meta - is_member, is_banned
</del><ins>+ 'page_arg' => 'grpage',
+ 'user_id' => bp_displayed_user_id(),
+ 'slug' => $slug,
+ 'search_terms' => $search_terms,
+ 'meta_query' => false,
+ 'include' => false,
+ 'exclude' => false,
+ 'populate_extras' => true,
</ins><span class="cx"> 'update_meta_cache' => true,
</span><del>- );
</del><ins>+ ), 'has_groups' );
</ins><span class="cx">
</span><del>- $r = bp_parse_args( $args, $defaults, 'has_groups' );
-
</del><ins>+ // Setup the Groups template global
</ins><span class="cx"> $groups_template = new BP_Groups_Template( array(
</span><span class="cx"> 'type' => $r['type'],
</span><span class="cx"> 'order' => $r['order'],
</span><span class="lines">@@ -384,6 +408,7 @@
</span><span class="cx"> 'update_meta_cache' => (bool) $r['update_meta_cache'],
</span><span class="cx"> ) );
</span><span class="cx">
</span><ins>+ // Filter and return whether or not the groups loop has groups in it
</ins><span class="cx"> return apply_filters( 'bp_has_groups', $groups_template->has_groups(), $groups_template, $r );
</span><span class="cx"> }
</span><span class="cx">
</span></span></pre>
</div>
</div>
</body>
</html>