<!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][12663] trunk: Add `xprofile_query` parameter to `bp_has_members()`.</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 { white-space: pre-line; 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/12663">12663</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/12663","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>boonebgorges</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-06-10 02:09:59 +0000 (Wed, 10 Jun 2020)</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 `xprofile_query` parameter to `bp_has_members()`.
And related functions/classes.
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/8309">#8309</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpmembersbpmembersfunctionsphp">trunk/src/bp-members/bp-members-functions.php</a></li>
<li><a href="#trunksrcbpmembersbpmemberstemplatephp">trunk/src/bp-members/bp-members-template.php</a></li>
<li><a href="#trunksrcbpmembersclassesclassbpcorememberstemplatephp">trunk/src/bp-members/classes/class-bp-core-members-template.php</a></li>
<li><a href="#trunktestsphpunittestcasesmemberstemplatephp">trunk/tests/phpunit/testcases/members/template.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpmembersbpmembersfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-members/bp-members-functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-members/bp-members-functions.php 2020-06-06 09:40:32 UTC (rev 12662)
+++ trunk/src/bp-members/bp-members-functions.php 2020-06-10 02:09:59 UTC (rev 12663)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -78,6 +78,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * bp_use_legacy_user_query value, returning true.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.2.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 7.0.0 Added `xprofile_query` parameter.
</ins><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 arguments. All are optional. See {@link BP_User_Query} for
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -96,6 +97,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type int $per_page Results per page. Default: 20.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type int $page Page of results. Default: 1.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type bool $populate_extras Fetch optional extras. Default: true.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type array $xprofile_query Filter results by xprofile data. Requires the xprofile
+ * component. See {@see BP_XProfile_Query} for details.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @type string|bool $count_total How to do total user count. Default: 'count_query'.
</span><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -117,6 +120,7 @@
</span><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"> 'populate_extras' => true, // Fetch the last active, where the user is a friend, total friend count, latest update.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'xprofile_query' => false,
</ins><span class="cx" style="display: block; padding: 0 10px"> 'count_total' => 'count_query' // What kind of total user count to do, if any. 'count_query', 'sql_calc_found_rows', or false.
</span><span class="cx" style="display: block; padding: 0 10px"> ), 'core_get_users' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunksrcbpmembersbpmemberstemplatephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-members/bp-members-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-members/bp-members-template.php 2020-06-06 09:40:32 UTC (rev 12662)
+++ trunk/src/bp-members/bp-members-template.php 2020-06-10 02:09:59 UTC (rev 12663)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -282,6 +282,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * display a list of members.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.2.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 7.0.0 Added `xprofile_query` parameter.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @global object $members_template {@link BP_Members_Template}
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -325,6 +326,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Default: false.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type mixed $meta_value When used with meta_key, limits results by the a matching
</span><span class="cx" style="display: block; padding: 0 10px"> * usermeta value. Default: false.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type array $xprofile_query Filter results by xprofile data. Requires the xprofile
+ * component. See {@see BP_XProfile_Query} for details.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @type bool $populate_extras Whether to fetch optional data, such as friend counts.
</span><span class="cx" style="display: block; padding: 0 10px"> * Default: true.
</span><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -378,6 +381,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'meta_key' => false, // Only return users with this usermeta.
</span><span class="cx" style="display: block; padding: 0 10px"> 'meta_value' => false, // Only return users where the usermeta value matches. Requires meta_key.
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'xprofile_query' => false,
</ins><span class="cx" style="display: block; padding: 0 10px"> 'populate_extras' => true // Fetch usermeta? Friend count, last active etc.
</span><span class="cx" style="display: block; padding: 0 10px"> ), 'has_members' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -411,7 +415,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $r['page_arg'],
</span><span class="cx" style="display: block; padding: 0 10px"> $r['member_type'],
</span><span class="cx" style="display: block; padding: 0 10px"> $r['member_type__in'],
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $r['member_type__not_in']
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $r['member_type__not_in'],
+ $r['xprofile_query']
</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>
<a id="trunksrcbpmembersclassesclassbpcorememberstemplatephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-members/classes/class-bp-core-members-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-members/classes/class-bp-core-members-template.php 2020-06-06 09:40:32 UTC (rev 12662)
+++ trunk/src/bp-members/classes/class-bp-core-members-template.php 2020-06-10 02:09:59 UTC (rev 12663)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -110,6 +110,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Constructor method.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.5.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 7.0.0 Added $xprofile_query parameter.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @see BP_User_Query for an in-depth description of parameters.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -130,8 +131,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array|string $member_type__in Array or comma-separated string of member types to limit results to.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array|string $member_type__not_in Array or comma-separated string of member types to exclude
</span><span class="cx" style="display: block; padding: 0 10px"> * from results.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $xprofile_query Filter results by xprofile data. Requires the xprofile
+ * component. See {@see BP_XProfile_Query} for details.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- function __construct( $type, $page_number, $per_page, $max, $user_id, $search_terms, $include, $populate_extras, $exclude, $meta_key, $meta_value, $page_arg = 'upage', $member_type = '', $member_type__in = '', $member_type__not_in = '' ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ function __construct( $type, $page_number, $per_page, $max, $user_id, $search_terms, $include, $populate_extras, $exclude, $meta_key, $meta_value, $page_arg = 'upage', $member_type = '', $member_type__in = '', $member_type__not_in = '', $xprofile_query = false ) {
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->pag_arg = sanitize_key( $page_arg );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->pag_page = bp_sanitize_pagination_arg( $this->pag_arg, $page_number );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -138,10 +141,28 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->pag_num = bp_sanitize_pagination_arg( 'num', $per_page );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->type = $type;
</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( $_REQUEST['letter'] ) )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! empty( $_REQUEST['letter'] ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->members = BP_Core_User::get_users_by_letter( $_REQUEST['letter'], $this->pag_num, $this->pag_page, $populate_extras, $exclude );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- else
- $this->members = bp_core_get_users( array( 'type' => $this->type, 'per_page' => $this->pag_num, 'page' => $this->pag_page, 'user_id' => $user_id, 'include' => $include, 'search_terms' => $search_terms, 'populate_extras' => $populate_extras, 'exclude' => $exclude, 'meta_key' => $meta_key, 'meta_value' => $meta_value, 'member_type' => $member_type, 'member_type__in' => $member_type__in, 'member_type__not_in' => $member_type__not_in ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } else {
+ $this->members = bp_core_get_users(
+ array(
+ 'type' => $this->type,
+ 'per_page' => $this->pag_num,
+ 'page' => $this->pag_page,
+ 'user_id' => $user_id,
+ 'include' => $include,
+ 'search_terms' => $search_terms,
+ 'populate_extras' => $populate_extras,
+ 'exclude' => $exclude,
+ 'meta_key' => $meta_key,
+ 'meta_value' => $meta_value,
+ 'member_type' => $member_type,
+ 'member_type__in' => $member_type__in,
+ 'member_type__not_in' => $member_type__not_in,
+ 'xprofile_query' => $xprofile_query,
+ )
+ );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( !$max || $max >= (int) $this->members['total'] )
</span><span class="cx" style="display: block; padding: 0 10px"> $this->total_member_count = (int) $this->members['total'];
</span></span></pre></div>
<a id="trunktestsphpunittestcasesmemberstemplatephp"></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/members/template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/members/template.php 2020-06-06 09:40:32 UTC (rev 12662)
+++ trunk/tests/phpunit/testcases/members/template.php 2020-06-10 02:09:59 UTC (rev 12663)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -186,6 +186,43 @@
</span><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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @group bp_has_members
+ * @ticket BP8309
+ */
+ public function test_bp_has_members_xprofile_query() {
+ $group_id = self::factory()->xprofile_group->create();
+ $field_id = self::factory()->xprofile_field->create( array(
+ 'field_group_id' => $group_id,
+ 'type' => 'textbox',
+ ) );
+ $users = self::factory()->user->create_many( 2 );
+
+ xprofile_set_field_data( $field_id, $users[0], 'foo' );
+ xprofile_set_field_data( $field_id, $users[1], 'bar' );
+
+ global $members_template;
+ $old_members_template = $members_template;
+
+ $args = array(
+ 'xprofile_query' => array(
+ array(
+ 'field' => $field_id,
+ 'value' => 'foo',
+ ),
+ ),
+ );
+
+ bp_has_members( $args );
+
+ $members = is_array( $members_template->members ) ? array_values( $members_template->members ) : array();
+ $member_ids = wp_list_pluck( $members, 'ID' );
+ $this->assertEqualSets( array( $users[0] ), $member_ids );
+
+ $GLOBALS['members_template'] = $old_members_template;
+ }
+
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @group bp_get_member_last_active
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_bp_get_member_last_active_default_params() {
</span></span></pre>
</div>
</div>
</body>
</html>