<!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][11532] trunk: Add 'status' parameter to BP_Groups_Group::get().</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/11532">11532</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/11532","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>2017-04-20 00:19:36 +0000 (Thu, 20 Apr 2017)</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'>Add 'status' parameter to BP_Groups_Group::get().
Add `$status` parameter to groups_get_groups()` and its underlying
function `BP_Groups_Group::get()`. Find groups by passing a single
status, a comma-separated list of statuses, or any array of statuses.
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/7501">#7501</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpgroupsbpgroupsfunctionsphp">trunk/src/bp-groups/bp-groups-functions.php</a></li>
<li><a href="#trunksrcbpgroupsclassesclassbpgroupsgroupphp">trunk/src/bp-groups/classes/class-bp-groups-group.php</a></li>
<li><a href="#trunktestsphpunittestcasesgroupsclassbpgroupsgroupphp">trunk/tests/phpunit/testcases/groups/class-bp-groups-group.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpgroupsbpgroupsfunctionsphp"></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-functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-groups/bp-groups-functions.php 2017-04-15 09:12:41 UTC (rev 11531)
+++ trunk/src/bp-groups/bp-groups-functions.php 2017-04-20 00:19:36 UTC (rev 11532)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -717,6 +717,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'group_type__not_in' => '', // Array or comma-separated list of group types that will be excluded from results.
</span><span class="cx" style="display: block; padding: 0 10px"> 'meta_query' => false, // Filter by groupmeta. See WP_Meta_Query for syntax.
</span><span class="cx" style="display: block; padding: 0 10px"> 'show_hidden' => false, // Show hidden groups to non-admins.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'status' => array(), // Array or comma-separated list of group statuses to limit results to.
</ins><span class="cx" style="display: block; padding: 0 10px"> 'per_page' => 20, // The number of results to return per page.
</span><span class="cx" style="display: block; padding: 0 10px"> 'page' => 1, // The page to return if limiting per page.
</span><span class="cx" style="display: block; padding: 0 10px"> 'update_meta_cache' => true, // Pre-fetch groupmeta for queried groups.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -739,6 +740,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'group_type__not_in' => $r['group_type__not_in'],
</span><span class="cx" style="display: block; padding: 0 10px"> 'meta_query' => $r['meta_query'],
</span><span class="cx" style="display: block; padding: 0 10px"> 'show_hidden' => $r['show_hidden'],
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'status' => $r['status'],
</ins><span class="cx" style="display: block; padding: 0 10px"> 'per_page' => $r['per_page'],
</span><span class="cx" style="display: block; padding: 0 10px"> 'page' => $r['page'],
</span><span class="cx" style="display: block; padding: 0 10px"> 'update_meta_cache' => $r['update_meta_cache'],
</span></span></pre></div>
<a id="trunksrcbpgroupsclassesclassbpgroupsgroupphp"></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/classes/class-bp-groups-group.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-groups/classes/class-bp-groups-group.php 2017-04-15 09:12:41 UTC (rev 11531)
+++ trunk/src/bp-groups/classes/class-bp-groups-group.php 2017-04-20 00:19:36 UTC (rev 11532)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -919,6 +919,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type bool $update_admin_cache Whether to pre-fetch administrator IDs for the returned
</span><span class="cx" style="display: block; padding: 0 10px"> * groups. Default: false.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type bool $show_hidden Whether to include hidden groups in results. Default: false.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type array|string $status Optional. Array or comma-separated list of group statuses to limit
+ * results to. If specified, $show_hidden is ignored.
+ * Default: empty array.
</ins><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array {
</span><span class="cx" style="display: block; padding: 0 10px"> * @type array $groups Array of group objects returned by the
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -969,6 +972,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'update_admin_cache' => false,
</span><span class="cx" style="display: block; padding: 0 10px"> 'exclude' => false,
</span><span class="cx" style="display: block; padding: 0 10px"> 'show_hidden' => false,
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'status' => array()
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $r = wp_parse_args( $args, $defaults );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -989,7 +993,15 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $where_conditions = array();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( empty( $r['show_hidden'] ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ if ( ! empty( $r['status'] ) ) {
+ if ( ! is_array( $r['status'] ) ) {
+ $r['status'] = preg_split( '/[\s,]+/', $r['status'] );
+ }
+ $r['status'] = array_map( 'sanitize_title', $r['status'] );
+ $status_in = "'" . implode( "','", $r['status'] ) . "'";
+ $where_conditions['status'] = "g.status IN ({$status_in})";
+ } elseif ( empty( $r['show_hidden'] ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $where_conditions['hidden'] = "g.status != 'hidden'";
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunktestsphpunittestcasesgroupsclassbpgroupsgroupphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/testcases/groups/class-bp-groups-group.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/groups/class-bp-groups-group.php 2017-04-15 09:12:41 UTC (rev 11531)
+++ trunk/tests/phpunit/testcases/groups/class-bp-groups-group.php 2017-04-20 00:19:36 UTC (rev 11532)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2116,6 +2116,72 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEqualSets( array( $g1, $g3 ), $found );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * @group get_by_status
+ */
+ public function test_get_by_status() {
+ $g1 = $this->factory->group->create(array(
+ 'status' => 'private'
+ ) );
+ $g2 = $this->factory->group->create( array(
+ 'status' => 'public'
+ ) );
+ $g3 = $this->factory->group->create( array(
+ 'status' => 'hidden'
+ ) );
+
+ $groups = BP_Groups_Group::get( array(
+ 'status' => array( 'private', 'hidden' ),
+ ) );
+
+ $found = wp_list_pluck( $groups['groups'], 'id' );
+ $this->assertEqualSets( array( $g1, $g3 ), $found );
+ }
+
+ /**
+ * @group get_by_status
+ */
+ public function test_get_by_status_accept_string() {
+ $g1 = $this->factory->group->create(array(
+ 'status' => 'private'
+ ) );
+ $g2 = $this->factory->group->create( array(
+ 'status' => 'public'
+ ) );
+ $g3 = $this->factory->group->create( array(
+ 'status' => 'hidden'
+ ) );
+
+ $groups = BP_Groups_Group::get( array(
+ 'status' => 'public',
+ ) );
+
+ $found = wp_list_pluck( $groups['groups'], 'id' );
+ $this->assertEqualSets( array( $g2 ), $found );
+ }
+
+ /**
+ * @group get_by_status
+ */
+ public function test_get_by_status_accept_comma_separated_string() {
+ $g1 = $this->factory->group->create(array(
+ 'status' => 'private'
+ ) );
+ $g2 = $this->factory->group->create( array(
+ 'status' => 'public'
+ ) );
+ $g3 = $this->factory->group->create( array(
+ 'status' => 'hidden'
+ ) );
+
+ $groups = BP_Groups_Group::get( array(
+ 'status' => 'private, hidden',
+ ) );
+
+ $found = wp_list_pluck( $groups['groups'], 'id' );
+ $this->assertEqualSets( array( $g1, $g3 ), $found );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span></span></pre>
</div>
</div>
</body>
</html>