Changeset 9210 for trunk/src/bp-members/bp-members-template.php

Timestamp:

12/04/2014 01:47:49 AM (10 years ago)

Author:

boonebgorges

Message:

Introduce Member Types API.

BuddyPress member types are akin to WordPress's custom post types. Developers
can use bp_register_member_type() to register their types with BuddyPress,
and BP will automatically provide a number of pieces of functionality:

• Mechanisms for storing and fetching member types (as a WP taxonomy term), with full cache support.
• A 'member_type' argument for the bp_has_members()/BP_User_Query stack, which allows filtering member loops by member type.
• Admin UI for changing member types on Dashboard > Users > Community Profile (appears when member types have been registered).

We'll continue to build out more core member type functionality in future
versions of BuddyPress. In the meantime, this is a good starting point for BP
site implementations to have a shared infrastructure for storing and retrieving
this data.

See #6006.

File:

• trunk/src/bp-members/bp-members-template.php (modified) (5 diffs)

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

@@ -222 +222 @@
      * @see BP_User_Query for an in-depth description of parameters.
      *
-     * @param string $type Sort order.
-     * @param int $page_number Page of results.
-     * @param int $per_page Number of results per page.
-     * @param int $max Max number of results to return.
-     * @param int $user_id Limit to friends of a user.
-     * @param string $search_terms Limit to users matching search terms.
-     * @param array $include Limit results by these user IDs.
-     * @param bool $populate_extras Fetch optional extras.
-     * @param array $exclude Exclude these IDs from results.
-     * @param array $meta_key Limit to users with a meta_key.
-     * @param array $meta_value Limit to users with a meta_value (with meta_key).
-     * @param array $page_arg Optional. The string used as a query
-     *        parameter in pagination links. Default: 'upage'.
-     */
-    function __construct( $type, $page_number, $per_page, $max, $user_id, $search_terms, $include, $populate_extras, $exclude, $meta_key, $meta_value, $page_arg = 'upage' ) {
+     * @param string       $type            Sort order.
+     * @param int          $page_number     Page of results.
+     * @param int          $per_page        Number of results per page.
+     * @param int          $max             Max number of results to return.
+     * @param int          $user_id         Limit to friends of a user.
+     * @param string       $search_terms    Limit to users matching search terms.
+     * @param array        $include         Limit results by these user IDs.
+     * @param bool         $populate_extras Fetch optional extras.
+     * @param array        $exclude         Exclude these IDs from results.
+     * @param array        $meta_key        Limit to users with a meta_key.
+     * @param array        $meta_value      Limit to users with a meta_value (with meta_key).
+     * @param array        $page_arg        Optional. The string used as a query parameter in pagination links.
+     *                                      Default: 'upage'.
+     * @param array|string $member_type     Array or comma-separated string of member types to limit results to.
+     */
+    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 = '' ) {
 
         $this->pag_page = !empty( $_REQUEST[$page_arg] ) ? intval( $_REQUEST[$page_arg] ) : (int) $page_number;
@@ -245 +246 @@
             $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 ) );
+            $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 ) );
 
         if ( !$max || $max >= (int) $this->members['total'] )
@@ -399 +400 @@
  *     string (eg, 'user_id=4&per_page=3').
  *
- *     @type int $type Sort order. 'active', 'random', 'newest', 'popular',
- *           'online', 'alphabetical'. Default: 'active'.
- *     @type int|bool $page Page of results to display. Default: 1.
- *     @type int|bool $per_page Number of results per page. Default: 20.
- *     @type int|bool $max Maximum number of results to return.
- *           Default: false (unlimited).
- *     @type string $page_arg The string used as a query parameter in
- *           pagination links. Default: 'bpage'.
- *     @type array|int|string|bool $include Limit results by a list of user
- *           IDs. Accepts an array, a single integer, a comma-separated list of
- *           IDs, or false (to disable this limiting). Default: false.
- *       'active', 'alphabetical', 'newest', or 'random'.
- *     @type array|int|string|bool $exclude Exclude users from results by ID.
- *           Accepts an array, a single integer, a comma-separated list of
- *           IDs, or false (to disable this limiting). Default: false.
- *     @type int $user_id If provided, results are limited to the friends of
- *           the specified user. When on a user's Friends page, defaults to
- *           the ID of the displayed user. Otherwise defaults to 0.
- *     @type string $search_terms Limit results by a search term. Default: null.
- *     @type string $meta_key Limit results by the presence of a usermeta key.
+ *     @type int                   $type            Sort order. Accepts 'active', 'random', 'newest', 'popular',
+ *                                                  'online', 'alphabetical'. Default: 'active'.
+ *     @type int|bool              $page            Page of results to display. Default: 1.
+ *     @type int|bool              $per_page        Number of results per page. Default: 20.
+ *     @type int|bool              $max             Maximum number of results to return. Default: false (unlimited).
+ *     @type string                $page_arg        The string used as a query parameter in pagination links.
+ *                                                  Default: 'bpage'.
+ *     @type array|int|string|bool $include         Limit results by a list of user IDs. Accepts an array, a
+ *                                                  single integer, a comma-separated list of IDs, or false (to
+ *                                                  disable this limiting). Accepts 'active', 'alphabetical',
+ *                                                  'newest', or 'random'. Default: false.
+ *     @type array|int|string|bool $exclude         Exclude users from results by ID. Accepts an array, a single
+ *                                                  integer, a comma-separated list of IDs, or false (to disable
+ *                                                  this limiting). Default: false.
+ *     @type int                   $user_id         If provided, results are limited to the friends of the specified
+ *                                                  user. When on a user's Friends page, defaults to the ID of the
+ *                                                  displayed user. Otherwise defaults to 0.
+ *     @type string|array          $member_type     Array or comma-separated list of member types to limit results to.
+ *     @type string                $search_terms    Limit results by a search term. Default: null.
+ *     @type string                $meta_key        Limit results by the presence of a usermeta key.
  *           Default: false.
- *     @type mixed $meta_value When used with meta_key, limits results by the
+ *     @type mixed                 $meta_value      When used with meta_key, limits results by the
  *           a matching usermeta value. Default: false.
- *     @type bool $populate_extras Whether to fetch optional data, such as
+ *     @type bool                  $populate_extras Whether to fetch optional data, such as
  *           friend counts. Default: true.
  * }
@@ -451 +452 @@
 
         'user_id'         => $user_id, // Pass a user_id to only show friends of this user
+        'member_type'     => '',
         'search_terms'    => null,     // Pass search_terms to filter users by their profile data
 
@@ -486 +488 @@
         $r['meta_key'],
         $r['meta_value'],
-        $r['page_arg']
+        $r['page_arg'],
+        $r['member_type']
     );