Changeset 12663

Timestamp:

06/10/2020 02:09:59 AM (4 years ago)

Author:

boonebgorges

Message:

Add xprofile_query parameter to bp_has_members().

And related functions/classes.

Fixes #8309.

Location:

trunk

Files:

• src/bp-members/bp-members-functions.php (modified) (3 diffs)
• src/bp-members/bp-members-template.php (modified) (4 diffs)
• src/bp-members/classes/class-bp-core-members-template.php (modified) (3 diffs)
• tests/phpunit/testcases/members/template.php (modified) (1 diff)

trunk/src/bp-members/bp-members-functions.php

@@ -79 +79 @@
  *
  * @since 1.2.0
+ * @since 7.0.0 Added `xprofile_query` parameter.
  *
  * @param array|string $args {
@@ -97 +98 @@
  *     @type int          $page                Page of results. Default: 1.
  *     @type bool         $populate_extras     Fetch optional extras. Default: true.
+ *     @type array        $xprofile_query      Filter results by xprofile data. Requires the xprofile
+ *                                             component. See {@see BP_XProfile_Query} for details.
  *     @type string|bool  $count_total         How to do total user count. Default: 'count_query'.
  * }
@@ -118 +121 @@
         'page'                => 1,            // The page to return if limiting per page.
         'populate_extras'     => true,         // Fetch the last active, where the user is a friend, total friend count, latest update.
+        'xprofile_query'      => false,
         'count_total'         => 'count_query' // What kind of total user count to do, if any. 'count_query', 'sql_calc_found_rows', or false.
     ), 'core_get_users' );

trunk/src/bp-members/bp-members-template.php

@@ -283 +283 @@
  *
  * @since 1.2.0
+ * @since 7.0.0 Added `xprofile_query` parameter.
  *
  * @global object $members_template {@link BP_Members_Template}
@@ -326 +327 @@
  *     @type mixed                 $meta_value          When used with meta_key, limits results by the a matching
  *                                                      usermeta value. Default: false.
+ *     @type array                 $xprofile_query      Filter results by xprofile data. Requires the xprofile
+ *                                                      component. See {@see BP_XProfile_Query} for details.
  *     @type bool                  $populate_extras     Whether to fetch optional data, such as friend counts.
  *                                                      Default: true.
@@ -379 +382 @@
         'meta_value'          => false,    // Only return users where the usermeta value matches. Requires meta_key.
 
+        'xprofile_query'      => false,
         'populate_extras'     => true      // Fetch usermeta? Friend count, last active etc.
     ), 'has_members' );
@@ -412 +416 @@
         $r['member_type'],
         $r['member_type__in'],
-        $r['member_type__not_in']
+        $r['member_type__not_in'],
+        $r['xprofile_query']
     );
 

trunk/src/bp-members/classes/class-bp-core-members-template.php

@@ -111 +111 @@
      *
      * @since 1.5.0
+     * @since 7.0.0 Added $xprofile_query parameter.
      *
      * @see BP_User_Query for an in-depth description of parameters.
@@ -131 +132 @@
      * @param array|string $member_type__not_in Array or comma-separated string of member types to exclude
      *                                          from results.
-     */
-    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 = '' ) {
+ *     @param array        $xprofile_query      Filter results by xprofile data. Requires the xprofile
+ *                                              component. See {@see BP_XProfile_Query} for details.
+     */
+    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 ) {
 
         $this->pag_arg  = sanitize_key( $page_arg );
@@ -139 +142 @@
         $this->type     = $type;
 
-        if ( !empty( $_REQUEST['letter'] ) )
+        if ( ! empty( $_REQUEST['letter'] ) ) {
             $this->members = BP_Core_User::get_users_by_letter( $_REQUEST['letter'], $this->pag_num, $this->pag_page, $populate_extras, $exclude );
-        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 ) );
+        } 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,
+                )
+            );
+        }
 
         if ( !$max || $max >= (int) $this->members['total'] )

trunk/tests/phpunit/testcases/members/template.php

@@ -185 +185 @@
         $GLOBALS['members_template'] = $old_members_template;
     }
+
+    /**
+     * @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;
+    }
+
 
     /**